diff --git a/OJP/OJP_Fare.xsd b/OJP/OJP_Fare.xsd index 6280723c9..21bd3df80 100644 --- a/OJP/OJP_Fare.xsd +++ b/OJP/OJP_Fare.xsd @@ -190,9 +190,9 @@ Identifies the "valid from" trip. - + - Identifies the "valid from" tripLeg. If missing, then valid from the first leg. + Identifies the "valid from" LEG. If missing, then valid from the first LEG. @@ -200,9 +200,9 @@ Identifies the "valid to" trip. - + - Identifies the "valid to" tripLeg. If missing, then valid to the last leg. + Identifies the "valid to" LEG. If missing, then valid to the last LEG. diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd index aacfec9bf..41cde75cf 100644 --- a/OJP/OJP_FareSupport.xsd +++ b/OJP/OJP_FareSupport.xsd @@ -657,19 +657,19 @@ ========================================== Trip Fare ========================================== - + - Range of trip legs (from - to) for which a Fare result (ticket) is valid. + Range of LEGs (from - to) for which a Fare result (ticket) is valid. - + - Identifies the "valid from" trip leg. + Identifies the "valid from" LEG. - + - Identifies the "valid to" trip leg. + Identifies the "valid to" LEG. @@ -684,7 +684,7 @@ Result-specific error messages. - + The sequence of passed fare zones. @@ -806,12 +806,12 @@ - Fare calculation is not possible because the suggested trip is not in compliance with the fare regulations, e.g. because of round trips, TripLegs that go forth and return or exceed the maximal total trip duration. + Fare calculation is not possible because the suggested trip is not in compliance with the fare regulations, e.g. because of round trips, LEGs that go forth and return or exceed the maximal total trip duration. - The ticket that has been specified in the request is valid for the suggested trip (or parts of it as defined by TripLegRange). + The ticket that has been specified in the request is valid for the suggested trip (or parts of it as defined by LegRange). diff --git a/OJP/OJP_JourneySupport.xsd b/OJP/OJP_JourneySupport.xsd index 73504ce09..ff7e197cd 100644 --- a/OJP/OJP_JourneySupport.xsd +++ b/OJP/OJP_JourneySupport.xsd @@ -721,14 +721,14 @@ - LINK PROJECTION on the infrastructure network of the trip leg section together with time information. + LINK PROJECTION on the infrastructure network of the leg section together with time information. - LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information + LINK PROJECTION on the infrastructure network of the LEG together with time information diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 30295fedb..ba85d38f0 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -411,9 +411,9 @@ Arrival time at destination. - + - Number of public transport trip legs. + Number of public transport legs. @@ -437,7 +437,7 @@ - [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs + [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more LEGs @@ -470,7 +470,7 @@ Trip distance. - + Legs of the trip @@ -490,14 +490,14 @@ - + a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange) - Id of this trip leg. Unique within trip result. + Id of this leg. Unique within trip result. @@ -515,7 +515,7 @@ - passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE. + passenger LEG with timetabled schedule. Corresponds to a RIDE. @@ -535,7 +535,7 @@ - Service that is used for this trip leg. + Service that is used for this leg. diff --git a/docs/generated/index.html b/docs/generated/index.html index c090732b4..621a4fea8 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -61,13 +61,13 @@

OJP - Open API for distributed Journey 2. OJP/OJP_Requests.xsd - OJP service requests and responses
  • 3. OJP/OJP_RequestSupport.xsd - Supporting definitions for OJP service requests and their responses
  • 4. OJP/OJP_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information
    • -
  • 5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
    • +
  • 5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
  • 6. OJP/OJP_Lines.xsd - Request and response definitions for information on lines
  • 7. OJP/OJP_Places.xsd - Request and response definitions for place information
  • 8. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information
  • 9. OJP/OJP_StopEvents.xsd - Request and response definitions for arrivals and departures of public transport services at stops
  • 10. OJP/OJP_TripInfo.xsd - Request and response definitions for information on a single trip
    • -
  • 11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
    • +
  • 11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning
  • 12. OJP/OJP_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles
  • 13. OJP/OJP_Availability.xsd - Request and response definitions for availability of tickets and services on a journey leg.
  • 14. OJP/OJP_Common.xsd - Supporting definitions of common structures
    • @@ -309,7 +309,7 @@

    OJP - Open API for distributed Journey

    4.2. The complex type StopFareRequestStructure

    StopFareRequestStructure

    Sub-request: stop-related fare information.

    The element contains a sequence of the following elements:

    →‍siri:StopPointRef

    1:1

    →‍siri:StopPointRef

    Date

    0:1

    xs:date

    Date for which to retrieve Fare information.

    4.3. The complex type StaticFareRequestStructure

    StaticFareRequestStructure

    General Fare information. May depend on date.

    The element contains a sequence of the following elements:

    Date

    0:1

    xs:date

    Date for which to retrieve Fare information.

    →‍FareProductRef

    0:*

    →‍FareProductRef

    Reference to a FareProduct.

    4.4. The complex type TripFareRequestStructure

    TripFareRequestStructure

    Structure of a Single Trip Fare Request.

    The element contains only one element:

    Trip

    1:1

    +Trip

    A complete trip from origin to destination

    4.5. The complex type MultiTripFareRequestStructure

    MultiTripFareRequestStructure

    Structure of a Multi Trip Fare Request.

    The element contains only one element:

    Trip

    1:*

    +Trip

    Multiple complete trips from multiple origins and multiple destination

    4.6. The FareResponseGroup group

    -

    FareResponseGroup

    FareResponse

    FareResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    FareResult

    0:*

    +FareResult

    Fare result choice element.

    4.7. The complex type FareResultStructure

    FareResultStructure

    Wrapper element for Fare results.

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    ID of this result.

    Problem

    0:*

    +FareProblem

    Problems related to this FARE result.

    Then, the element contains one of the following elements:

    a

    MultiTripFareResult

    -1:*

    +MultiTripFareResult

    Fare and FareProducts for multiple trips.

    b

    StaticFareResult

    -1:1

    +StaticFareResult

    Static Fare information.

    c

    StopFareResult

    -1:1

    +StopFareResult

    Stop-related Fare information.

    d

    TripFareResult

    -1:*

    +TripFareResult

    Fare and FareProducts for a given trip.

    4.8. The complex type StopFareResultStructure

    StopFareResultStructure

    Stop-related Fare information.

    The element contains a sequence of the following elements:

    TariffZoneListInArea

    1:*

    +TariffZoneListInArea

    One or more lists of Fare zones that belong to a Fare authority/area.

    Extension

    0:1

    xs:anyType

    4.9. The complex type StaticFareResultStructure

    StaticFareResultStructure

    General Fare information.

    The element contains a sequence of the following elements:

    FareProduct

    0:*

    +FareProduct

    [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information.

    StaticInfoUrl

    0:*

    +WebLink

    URL to information page on the web.

    Extension

    0:1

    xs:anyType

    4.10. The complex type TripFareProductReferenceStructure

    TripFareProductReferenceStructure

    Element that connects FareProducts to trips. A TripFareProduct is a FAREPRODUCT covering a part or the whole of a TRIP from boarding the first public transport vehicle to alighting from the last public transport vehicle (corresponds to a package of PREASSIGNED FARE PRODUCTs)

    The element contains a sequence of the following elements:

    →‍FareProductRef

    1:1

    →‍FareProductRef

    Reference to a FareProduct.

    FromTripIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" trip.

    FromTripLegIdRef

    0:1

    xs:NMTOKEN

    Identifies the "valid from" tripLeg. If missing, then valid from the first leg.

    ToTripIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" trip.

    ToTripLegIdRef

    0:1

    xs:NMTOKEN

    Identifies the "valid to" tripLeg. If missing, then valid to the last leg.

    4.11. The complex type MultiTripFareResultStructure

    MultiTripFareResultStructure

    Structure of a Multi Trip Fare Request result

    The element contains a sequence of the following elements:

    TripFareProductReference

    1:*

    +TripFareProductReference

    Non-empty list of trip references in the corresponding MultiTripFareRequestStructure

    FareProduct

    0:*

    +FareProduct

    Zero, one or more FareProducts that are valid for the referenced trips / part of trips.

    PassedZones

    0:1

    +TariffZoneListInArea

    The set of passed zones.

    StaticInfoUrl

    0:*

    +WebLink

    URL to Fare information pages on the web.

    +

    4.7. The complex type FareResultStructure

    FareResultStructure

    Wrapper element for Fare results.

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    ID of this result.

    Problem

    0:*

    +FareProblem

    Problems related to this FARE result.

    Then, the element contains one of the following elements:

    a

    MultiTripFareResult

    -1:*

    +MultiTripFareResult

    Fare and FareProducts for multiple trips.

    b

    StaticFareResult

    -1:1

    +StaticFareResult

    Static Fare information.

    c

    StopFareResult

    -1:1

    +StopFareResult

    Stop-related Fare information.

    d

    TripFareResult

    -1:*

    +TripFareResult

    Fare and FareProducts for a given trip.

    4.8. The complex type StopFareResultStructure

    StopFareResultStructure

    Stop-related Fare information.

    The element contains a sequence of the following elements:

    TariffZoneListInArea

    1:*

    +TariffZoneListInArea

    One or more lists of Fare zones that belong to a Fare authority/area.

    Extension

    0:1

    xs:anyType

    4.9. The complex type StaticFareResultStructure

    StaticFareResultStructure

    General Fare information.

    The element contains a sequence of the following elements:

    FareProduct

    0:*

    +FareProduct

    [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information.

    StaticInfoUrl

    0:*

    +WebLink

    URL to information page on the web.

    Extension

    0:1

    xs:anyType

    4.10. The complex type TripFareProductReferenceStructure

    TripFareProductReferenceStructure

    Element that connects FareProducts to trips. A TripFareProduct is a FAREPRODUCT covering a part or the whole of a TRIP from boarding the first public transport vehicle to alighting from the last public transport vehicle (corresponds to a package of PREASSIGNED FARE PRODUCTs)

    The element contains a sequence of the following elements:

    →‍FareProductRef

    1:1

    →‍FareProductRef

    Reference to a FareProduct.

    FromTripIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" trip.

    FromLegIdRef

    0:1

    xs:NMTOKEN

    Identifies the "valid from" LEG. If missing, then valid from the first LEG.

    ToTripIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" trip.

    ToLegIdRef

    0:1

    xs:NMTOKEN

    Identifies the "valid to" LEG. If missing, then valid to the last LEG.

    4.11. The complex type MultiTripFareResultStructure

    MultiTripFareResultStructure

    Structure of a Multi Trip Fare Request result

    The element contains a sequence of the following elements:

    TripFareProductReference

    1:*

    +TripFareProductReference

    Non-empty list of trip references in the corresponding MultiTripFareRequestStructure

    FareProduct

    0:*

    +FareProduct

    Zero, one or more FareProducts that are valid for the referenced trips / part of trips.

    PassedZones

    0:1

    +TariffZoneListInArea

    The set of passed zones.

    StaticInfoUrl

    0:*

    +WebLink

    URL to Fare information pages on the web.

    5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips

    5.1. Simple type definitions

    BookingAccessEnumeration

    public | authorisedPublic | staff | other

    Allowed values for Booking Access.

    BookingMethodEnumeration

    callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none

    Allowed values for Flexible Booking method.

    BookingProcessEnumeration

    xs:normalizedString

    Allowed values for Booking Process UIC 7037 Code list.

    ContactTypeEnumeration

    any | information | reservations | lostProperty | publicRelations | complaints | emergency | other

    Allowed values for CONTACT role.

    EmailAddressType

    xs:normalizedString

    Email address type a@b.

    EntitlementProductCodeType

    xs:NMTOKEN

    Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority.

    FareAuthorityCodeType

    xs:NMTOKEN

    Identifier of a Fare Authority.

    FareProblemTypeEnumeration

    FARE_OUTOFAREA | FARE_JOURNEYNOTPERMITTED | FARE_ADDITIONALCHARGES | FARE_ADDITIONALTICKETS | FARE_ROUTENOTFEASIBLE | FARE_ALREADYCOVERED | FARE_DATEOUTOFRANGE | FARE_STOPPOINTUNKNOWN | FARE_OTHER

    Types of problems that may be returned in responses to FARE requests.

    FareProductIdType

    xs:NMTOKEN

    Identifier of a FareProduct

    GroupBookingEnumeration

    xs:normalizedString

    Allowed values for Group Booking.

    PassengerCategoryEnumeration

    Adult | Child | Senior | Youth | Disabled

    [a simplified and specialised view of USER PROFILE in TM and NeTEx] classification of passengers by age or other factors that may determine the fare they will need to pay.

    Percentage

    xs:decimal

    A percentage value between 0 and 100

    PhoneType

    xs:normalizedString

    Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc.

    PurchaseMomentEnumeration

    xs:normalizedString

    Allowed values for Purchase Moment.

    PurchaseWhenEnumeration

    xs:normalizedString

    Allowed values for Purchase when.

    TariffZoneCodeType

    xs:NMTOKEN

    Identifier of a fare zone.

    TypeOfFareClassEnumeration

    all | first | second | third | business | economy

    classes of travel available on a particular service which will affect the price to be paid

    5.2. The complex type FareAuthorityRefStructure

    FareAuthorityRefStructure

    FareAuthorityCode

    Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs).

    5.3. The toplevel element FareAuthorityRef

    FareAuthorityRef

    +FareAuthorityRef

    Reference to a Fare Authority.

    5.4. The FareAuthorityGroup group

    @@ -365,13 +365,13 @@

    OJP - Open API for distributed Journey

    -

    FareAuthorityGroup

    Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs

    FareAuthority

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    FareAuthorityText

    1:1

    xs:string

    Textual description or name of Fare authority.

    FareProductBooking

    InfoUrl

    0:*

    +WebLink

    URL to information for this FareProduct

    SaleUrl

    0:*

    +WebLink

    URL to buy the FareProduct online.

    BookingArrangements

    0:*

    +BookingArrangementsContainer

    5.26. The TripLegRangeGroup group

    - - -

    TripLegRangeGroup

    Range of trip legs (from - to) for which a Fare result (ticket) is valid.

    TripLegRange

    FromTripLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" trip leg.

    ToTripLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" trip leg.

    5.27. The complex type TripFareResultStructure

    - - -

    TripFareResultStructure

    Structure of a Single Trip Fare Request result

    The element contains a sequence of the following elements:

    Problem

    0:*

    +FareProblem

    Result-specific error messages.

    TripLegRange

    FromTripLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" trip leg.

    ToTripLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" trip leg.

    PassedZones

    0:1

    +TariffZoneListInArea

    The sequence of passed fare zones.

    FareProduct

    0:*

    +FareProduct

    One ore more FareProducts that are valid for this part of the trip.

    StaticInfoUrl

    0:*

    +WebLink

    URL to static information page on the web.

    5.28. The complex type FarePassengerStructure

    FarePassengerStructure

    [a specialised form of USER PROFILE in TM and NeTEx] attributes of a passenger that influence the price to be paid by that passenger for a FARE PRODUCT.

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    Age

    -1:1

    xs:nonNegativeInteger

    Age of the passenger on the day of travel.

    b

    PassengerCategory

    -1:1

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    EntitlementProducts

    0:1

    +EntitlementProductList

    A list of ENTITLEMENT PRODUCTs.

    Then, the element contains one of the following elements:

    a

    SalesPackageElementRef

    -1:*

    +FareProductRef

    Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it.

    b

    ZonesAlreadyPaid

    -1:1

    +TariffZoneRefList

    Fare zones for which the passenger already has a valid FareProduct.

    5.29. The FareDataFilterGroup group

    +

    FareDataFilterGroup

    Data filter group for Fare request.

    5.26. The LegRangeGroup group

    + + +

    LegRangeGroup

    Range of LEGs (from - to) for which a Fare result (ticket) is valid.

    LegRange

    FromLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" LEG.

    ToLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" LEG.

    5.27. The complex type TripFareResultStructure

    + + +

    TripFareResultStructure

    Structure of a Single Trip Fare Request result

    The element contains a sequence of the following elements:

    Problem

    0:*

    +FareProblem

    Result-specific error messages.

    LegRange

    FromLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" LEG.

    ToLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" LEG.

    PassedZones

    0:1

    +TariffZoneListInArea

    The sequence of passed fare zones.

    FareProduct

    0:*

    +FareProduct

    One ore more FareProducts that are valid for this part of the trip.

    StaticInfoUrl

    0:*

    +WebLink

    URL to static information page on the web.

    5.28. The complex type FarePassengerStructure

    FarePassengerStructure

    [a specialised form of USER PROFILE in TM and NeTEx] attributes of a passenger that influence the price to be paid by that passenger for a FARE PRODUCT.

    The element contains a sequence of the following elements:

    Then, the element contains one of the following elements:

    a

    Age

    -1:1

    xs:nonNegativeInteger

    Age of the passenger on the day of travel.

    b

    PassengerCategory

    -1:1

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    EntitlementProducts

    0:1

    +EntitlementProductList

    A list of ENTITLEMENT PRODUCTs.

    Then, the element contains one of the following elements:

    a

    SalesPackageElementRef

    -1:*

    +FareProductRef

    Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it.

    b

    ZonesAlreadyPaid

    -1:1

    +TariffZoneRefList

    Fare zones for which the passenger already has a valid FareProduct.

    5.29. The FareDataFilterGroup group

    @@ -836,10 +836,10 @@

    OJP - Open API for distributed Journey

    FareDataFilterGroup

    Data filter group for Fare request.

    FareDataFilter

    FareAuthorityFilter

    0:*

    +FareAuthorityRef

    Fare authority for which to retrieve Fare information.

    PassengerCategory

    0:*

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class).

    11.8. The complex type OptimisationMethodList

    OptimisationMethodList

    List of OptimisationMethods. The order of precedence - if used at all - is high to low. In single criteria optimisers the optimisation methods may be used in parallel and not truly used to score the results.

    The element contains only one element:

    OptimisationMethod

    1:*

    OptimisationMethod

    11.9. The complex type NotViaStructure

    NotViaStructure

    NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    11.10. The complex type NoChangeAtStructure

    NoChangeAtStructure

    no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP.

    The element contains only one element:

    Then, the element contains one of the following elements:

    a

    →‍siri:StopPointRef

    -1:1

    →‍siri:StopPointRef

    b

    →‍StopPlaceRef

    -1:1

    →‍StopPlaceRef

    Reference to a Stop Place

    11.11. The complex type TariffzoneFilterStructure

    TariffzoneFilterStructure

    The element contains a sequence of the following elements:

    Exclude

    0:1

    xs:boolean

    Whether to include or exclude given tariff zones in the list from the search. Default is to include.

    TariffZones

    1:1

    +TariffZoneListInArea

    11.12. The TripResponseGroup group

    -

    TripResponseGroup

    Trip response structure.

    TripResponse

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    TripResult

    0:*

    +TripResult

    The trip results found by the server.

    11.13. The complex type TripResultStructure

    TripResultStructure

    Structure for a single trip result and associated problems.

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    Id of this trip result for referencing purposes. Unique within trip response.

    Problem

    0:*

    +TripProblem

    Problems related to this Trip result.

    Then, the element contains one of the following elements:

    a

    Trip

    -1:1

    +Trip

    Detailed information on trip.

    b

    TripSummary

    -1:1

    +TripSummary

    Summary on trip. Only if requestor set TripSummaryOnly in request.

    TripFare

    0:*

    +TripFareResult

    11.14. The complex type TripSummaryStructure

    +

    TripSummaryStructure

    Structure for trip overview information.

    The element contains a sequence of the following elements:

    TripId

    1:1

    xs:NMTOKEN

    Id of this trip for referencing purposes. Unique within trip response.

    Origin

    0:1

    +PlaceRef

    Describes the origin situation of this trip.

    Destination

    0:1

    +PlaceRef

    Describes the arrival situation of this trip.

    Duration

    0:1

    xs:duration

    Overall duration of the trip.

    StartTime

    0:1

    xs:dateTime

    Departure time at origin.

    EndTime

    0:1

    xs:dateTime

    Arrival time at destination.

    PTTripLegs

    0:1

    xs:nonNegativeInteger

    Number of public transport trip legs.

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    11.13. The complex type TripResultStructure

    TripResultStructure

    Structure for a single trip result and associated problems.

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    Id of this trip result for referencing purposes. Unique within trip response.

    Problem

    0:*

    +TripProblem

    Problems related to this Trip result.

    Then, the element contains one of the following elements:

    a

    Trip

    -1:1

    +Trip

    Detailed information on trip.

    b

    TripSummary

    -1:1

    +TripSummary

    Summary on trip. Only if requestor set TripSummaryOnly in request.

    TripFare

    0:*

    +TripFareResult

    11.14. The complex type TripSummaryStructure

    -

    TripSummaryStructure

    Structure for trip overview information.

    The element contains a sequence of the following elements:

    TripId

    1:1

    xs:NMTOKEN

    Id of this trip for referencing purposes. Unique within trip response.

    Origin

    0:1

    +PlaceRef

    Describes the origin situation of this trip.

    Destination

    0:1

    +PlaceRef

    Describes the arrival situation of this trip.

    Duration

    0:1

    xs:duration

    Overall duration of the trip.

    StartTime

    0:1

    xs:dateTime

    Departure time at origin.

    EndTime

    0:1

    xs:dateTime

    Arrival time at destination.

    PTLegs

    0:1

    xs:nonNegativeInteger

    Number of public transport legs.

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    OperatingDays

    OperatingDays

    0:1

    +OperatingDays

    Bit string definition of operating days.

    OperatingDaysDescription

    0:1

    +InternationalText

    Textual description of the operation days, e.g. "monday to friday" or "not on holidays".

    Feasibility

    0:*

    Feasibility

    Information about the feasibility of the TRIP, in particular with respect to the access features used.

    SituationFullRefs

    0:1

    +SituationRefList

    A list of references to SITUATIONs.

    Extension

    0:1

    xs:anyType

    11.15. The complex type TripStructure

    +

    TripStructure

    [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs

    The element contains a sequence of the following elements:

    TripId

    1:1

    xs:NMTOKEN

    Id of this trip for referencing purposes. Unique within trip response.

    Duration

    1:1

    xs:duration

    Overall duration of the trip.

    StartTime

    1:1

    xs:dateTime

    Departure time at origin.

    EndTime

    1:1

    xs:dateTime

    Arrival time at destination.

    Transfers

    1:1

    xs:nonNegativeInteger

    Number of interchanges.

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    TripLeg

    1:*

    +TripLeg

    Legs of the trip

    Feasibility

    0:*

    Feasibility

    Information about the feasibility of the TRIP, in particular with respect to the access features used.

    SituationFullRefs

    0:1

    +SituationRefList

    A list of references to SITUATIONs.

    Extension

    0:1

    xs:anyType

    11.15. The complex type TripStructure

    @@ -848,13 +848,13 @@

    OJP - Open API for distributed Journey

    -

    TripStructure

    [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more LEGs

    The element contains a sequence of the following elements:

    TripId

    1:1

    xs:NMTOKEN

    Id of this trip for referencing purposes. Unique within trip response.

    Duration

    1:1

    xs:duration

    Overall duration of the trip.

    StartTime

    1:1

    xs:dateTime

    Departure time at origin.

    EndTime

    1:1

    xs:dateTime

    Arrival time at destination.

    Transfers

    1:1

    xs:nonNegativeInteger

    Number of interchanges.

    Distance

    0:1

    siri:DistanceType

    Trip distance.

    Leg

    1:*

    +Leg

    Legs of the trip

    OperatingDays

    OperatingDays

    0:1

    +OperatingDays

    Bit string definition of operating days.

    OperatingDaysDescription

    0:1

    +InternationalText

    Textual description of the operation days, e.g. "monday to friday" or "not on holidays".

    Deviation

    0:1

    xs:boolean

    Whether this trip deviates from the planned service pattern. Default is false.

    Delayed

    0:1

    xs:boolean

    Whether this trip is delayed. Default is false.

    Infeasible

    0:1

    xs:boolean

    Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false.

    Feasibility

    0:*

    Feasibility

    Information about the feasibility of the TRIP, in particular with respect to the access features used.

    SituationFullRefs

    0:1

    +SituationRefList

    A list of references to SITUATIONs.

    Extension

    0:1

    xs:anyType

    11.16. The complex type TripLegStructure

    +

    TripLegStructure

    a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)

    The element contains a sequence of the following elements:

    LegId

    1:1

    xs:NMTOKEN

    Id of this trip leg. Unique within trip result.

    ParticipantRef

    0:1

    siri:ParticipantRefStructure

    [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)

    Then, the element contains one of the following elements:

    a

    ContinuousLeg

    -1:1

    +ContinuousLeg

    b

    TimedLeg

    -1:1

    +TimedLeg

    c

    TransferLeg

    -1:1

    +TransferLeg

    Feasibility

    0:*

    Feasibility

    Information about the feasibility of the TRIP, in particular with respect to the access features used.

    SituationFullRefs

    0:1

    +SituationRefList

    A list of references to SITUATIONs.

    Extension

    0:1

    xs:anyType

    11.16. The complex type LegStructure

    -

    LegStructure

    a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)

    The element contains a sequence of the following elements:

    LegId

    1:1

    xs:NMTOKEN

    Id of this leg. Unique within trip result.

    ParticipantRef

    0:1

    siri:ParticipantRefStructure

    [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s)

    Then, the element contains one of the following elements:

    a

    ContinuousLeg

    -1:1

    +ContinuousLeg

    b

    TimedLeg

    -1:1

    +TimedLeg

    c

    TransferLeg

    -1:1

    +TransferLeg

    Sustainability

    EmissionCO2

    0:1

    The element contains a sequence of the following elements:

    KilogramPerPersonKm

    1:1

    Kilogram by person and by kilometer of CO2 emission.

    ConfidenceLevel

    0:1

    Percentage

    Confidence level of the emission value in percent.

    11.17. The complex type TimedLegStructure

    +

    TimedLegStructure

    passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE.

    The element contains a sequence of the following elements:

    LegBoard

    1:1

    +LegBoard

    Stop/Station where boarding is done

    LegIntermediates

    0:*

    +LegIntermediate

    information about the intermediate passed stop points.

    LegAlight

    1:1

    +LegAlight

    Stop/Station to alight

    Service

    1:1

    +DatedJourney

    Service that is used for this trip leg.

    LegAttribute

    0:*

    +LegAttribute

    Attributes that are not valid on the whole service, but only on parts of the journey leg.

    11.17. The complex type TimedLegStructure

    @@ -1331,7 +1331,7 @@

    OJP - Open API for distributed Journey

    -

    TimedLegStructure

    passenger LEG with timetabled schedule. Corresponds to a RIDE.

    The element contains a sequence of the following elements:

    LegBoard

    1:1

    +LegBoard

    Stop/Station where boarding is done

    LegIntermediates

    0:*

    +LegIntermediate

    information about the intermediate passed stop points.

    LegAlight

    1:1

    +LegAlight

    Stop/Station to alight

    Service

    1:1

    +DatedJourney

    Service that is used for this leg.

    LegAttribute

    0:*

    +LegAttribute

    Attributes that are not valid on the whole service, but only on parts of the journey leg.

    OperatingDays

    OperatingDays

    0:1

    +OperatingDays

    Bit string definition of operating days.

    OperatingDaysDescription

    0:1

    +InternationalText

    Textual description of the operation days, e.g. "monday to friday" or "not on holidays".

    LegTrack

    0:1

    +LegTrack

    Geographic embedding of this leg.

    The element contains a sequence of the following elements:

    FromStopSeqNumber

    0:1

    xs:positiveInteger

    The attribute is valid from the stop point with this sequence number within the leg. If missing it is valid from the beginning of the leg.

    ToStopSeqNumber

    0:1

    xs:positiveInteger

    The attribute is valid to the stop point (inclusively) with this sequence number within the leg. If missing it is valid to the end of the leg.

    12.30. The complex type LegTrackStructure

    LegTrackStructure

    The LINK PROJECTION of a Leg onto the topography of the route being followed.

    The element contains only one element:

    TrackSection

    1:*

    +TrackSection

    LINK PROJECTION on the infrastructure network of the trip leg section together with time information.

    12.31. The complex type TrackSectionStructure

    TrackSectionStructure

    LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information

    The element contains a sequence of the following elements:

    TrackStart

    0:1

    +PlaceRef

    Start place of this track.

    TrackEnd

    0:1

    +PlaceRef

    End place of this track.

    LinkProjection

    0:1

    +LinearShape

    An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE.

    RoadName

    0:1

    xs:string

    Name of the road this track section is attached to.

    Duration

    0:1

    xs:duration

    Duration the passenger needs to travel through this track section.

    Length

    0:1

    siri:DistanceType

    Length of this track section.

    Extension

    0:1

    xs:anyType

    +

    12.30. The complex type LegTrackStructure

    LegTrackStructure

    The LINK PROJECTION of a Leg onto the topography of the route being followed.

    The element contains only one element:

    TrackSection

    1:*

    +TrackSection

    LINK PROJECTION on the infrastructure network of the leg section together with time information.

    12.31. The complex type TrackSectionStructure

    TrackSectionStructure

    LINK PROJECTION on the infrastructure network of the LEG together with time information

    The element contains a sequence of the following elements:

    TrackStart

    0:1

    +PlaceRef

    Start place of this track.

    TrackEnd

    0:1

    +PlaceRef

    End place of this track.

    LinkProjection

    0:1

    +LinearShape

    An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE.

    RoadName

    0:1

    xs:string

    Name of the road this track section is attached to.

    Duration

    0:1

    xs:duration

    Duration the passenger needs to travel through this track section.

    Length

    0:1

    siri:DistanceType

    Length of this track section.

    Extension

    0:1

    xs:anyType

    13. OJP/OJP_Availability.xsd - Request and response definitions for availability of tickets and services on a journey leg.

    13.1. Simple type definitions

    AvailabilityProblemTypeEnumeration

    AVAILIBILITY_NOSERIVCEFOUND | AVAILABILITY_LOCATIONUNSERVED | AVAILABILITY_LOCATIONUNKNOWN | AVAILABILITY_OUTSIDERULES | AVAILABILITY_SERVICEDISRUPTED | AVAILABILITY_UNAVAILABLE | AVAILABILITY_OTHER

    Types of problems that may be returned in responses to AVAILABILITY requests.

    BookableServiceItemTypeEnumeration

    wheelchair | motorisedWheelchair | foldableWheelchair | walkingFrame | pram | heavyLuggage | childSeatTakenAlong | childSeatSupplied | babyCarrierTakenAlong | babyCarrierSupplied | seatBoosterSupplied | bicycle | guideDog | dog | boardingAssistance | alightingAssistance | onboardAssistance | unassistedMinorAssistance

    Types of bookable service items.

    13.2. The AvailabilityRequestGroup group

    diff --git a/examples/switzerland/Trip_001_Response.xml b/examples/switzerland/Trip_001_Response.xml index 952eaa1a3..2e7b05211 100644 --- a/examples/switzerland/Trip_001_Response.xml +++ b/examples/switzerland/Trip_001_Response.xml @@ -532,7 +532,7 @@ 2020-09-30T12:21:00Z0125484 - + 1 @@ -614,7 +614,7 @@ - + @@ -626,7 +626,7 @@ 2020-09-30T13:21:00Z 0 125484 - + 1 @@ -708,7 +708,7 @@ - + @@ -720,7 +720,7 @@ 2020-09-30T14:21:00Z 0 125484 - + 1 @@ -802,7 +802,7 @@ - + @@ -814,7 +814,7 @@ 2020-09-30T15:21:00Z 0 125484 - + 1 @@ -896,7 +896,7 @@ - + @@ -908,7 +908,7 @@ 2020-09-30T16:21:00Z 0 125484 - + 1 @@ -990,7 +990,7 @@ - +

    AvailabilityRequestGroup

    Availability request. Used to check the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY or SINGLE JOURNEY. Be aware that usually after the response arrives, the rest of the TRIP must be recalculated. As especially pickup and setdown locations may have shifted from where they were in the previously calculated TRIP.

    The element contains one of the following elements:

    AvailabilityRequest

    a

    PublicTransport

    -1:1

    +BookingPTLeg

    Definition of the journey leg to be covered by public transport. Other mobility services can be added later.

    MobilityUser

    1:*

    +BookingUser

    Passenger(s) for whom the service needs to be booked, one MobilityUser per passenger.