diff --git a/OJP/OJP_All.xsd b/OJP/OJP_All.xsd index 6bbc10680..35dd86ac8 100644 --- a/OJP/OJP_All.xsd +++ b/OJP/OJP_All.xsd @@ -20,4 +20,5 @@ + diff --git a/OJP/OJP_Common.xsd b/OJP/OJP_Common.xsd index c1facbefe..1860f56f8 100644 --- a/OJP/OJP_Common.xsd +++ b/OJP/OJP_Common.xsd @@ -83,6 +83,15 @@ + + + A percentage value between 0 and 100 + + + + + + Area described as a polygon. diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd index 1da4144e6..2700ec4be 100644 --- a/OJP/OJP_FareSupport.xsd +++ b/OJP/OJP_FareSupport.xsd @@ -18,15 +18,6 @@ - - - A percentage value between 0 and 100 - - - - - - ========================================== Fare Authority ========================================== diff --git a/OJP/OJP_Requests.xsd b/OJP/OJP_Requests.xsd index b61f23824..e08330cdb 100644 --- a/OJP/OJP_Requests.xsd +++ b/OJP/OJP_Requests.xsd @@ -194,6 +194,32 @@ + + ========================================== Status Service ========================================== + + + + + + + + + + + + + + + + + + + + + + + + ========================================== TripRefine Service ========================================== diff --git a/OJP/OJP_Status.xsd b/OJP/OJP_Status.xsd new file mode 100644 index 000000000..22e56dd3a --- /dev/null +++ b/OJP/OJP_Status.xsd @@ -0,0 +1,72 @@ + + + + OJP/OJP_Status.xsd - OJP Status request and response + + + + + + =============================== Status Service ========================================== + + + + Types of problems that may be returned in responses to status requests. + + + + + Usage of this instance is deprecated. Contact the provider for more information. + + + + + A problem has occurred that does not have a specific problem type. + + + + + + + + + + + + + + + + + + + =============================== Status Response Group ========================================== + + + + Status response group. + + + + + Time when the service was started. + + + + + Time when the service started responding to queries. + + + + + Time when the timetable was last updated. + + + + + Information about the server build. + + + + + diff --git a/docs/generated/index.html b/docs/generated/index.html index 9b845cf80..7a49c1b1c 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -58,7 +58,7 @@

OJP - Open API for distributed Journey
  • 1. OJP.xsd - OJP messages as extension of SIRI
  • -
  • 2. OJP/OJP_Requests.xsd - OJP service requests and responses
  • +
  • 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
  • @@ -75,6 +75,7 @@

    OJP - Open API for distributed Journey 16. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
  • 17. OJP/OJP_SituationSupport.xsd - Supporting definitions for situations containing wrappers for SIRI Situation Exchange service (SIRI SX)
  • 18. OJP/OJP_Utility.xsd - Support definitions not specifically related to the public transport domain
  • +
  • 19. OJP/OJP_Status.xsd - OJP Status request and response
  • @@ -227,7 +228,24 @@

    OJP - Open API for distributed Journey

    MultiPointTripResult

    0:*

    +MultiPointTripResult

    The trip results found by the server.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    -

    2.29. The toplevel element OJPTripRefineRequest

    OJPTripRefineRequest

    +OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.30. The complex type OJPTripRefineRequestStructure

    +

    OJPTripRefineRequestStructure

    +AbstractOJPServiceRequest

    2.29. The toplevel element OJPStatusRequest

    OJPStatusRequest

    +OJPStatusRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.30. The complex type OJPStatusRequestStructure

    + + + +

    OJPStatusRequestStructure

    +AbstractOJPServiceRequest

    The element contains only one element:

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.31. The toplevel element OJPStatusDelivery

    OJPStatusDelivery

    +OJPStatusDelivery (↔ siri:AbstractFunctionalServiceDelivery)

    2.32. The complex type OJPStatusDeliveryStructure

    + + + + + + + + + + + + +

    OJPStatusDeliveryStructure

    siri:AbstractServiceDeliveryStructure

    The element contains a sequence of the following elements:

    →‍OJPStatusRequest

    0:1

    →‍OJPStatusRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

    identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems.

    CalcTime

    0:1

    Calc

    Calculation time.

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    OJPStatusResponse

    ServiceStarted

    0:1

    xs:dateTime

    Time when the service was started.

    ServiceReady

    0:1

    xs:dateTime

    Time when the service started responding to queries.

    LastTimetableUpdate

    0:1

    xs:dateTime

    Time when the timetable was last updated.

    ServerBuildVersion

    0:1

    xs:normalizedString

    Information about the server build.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.33. The toplevel element OJPTripRefineRequest

    OJPTripRefineRequest

    +OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.34. The complex type OJPTripRefineRequestStructure

    @@ -235,7 +253,7 @@

    OJP - Open API for distributed Journey

    -

    OJPTripRefineRequestStructure

    +AbstractOJPServiceRequest

    The element contains a sequence of the following elements:

    TripRefineRequest

    RefineParams

    0:1

    +TripRefineParam

    Options to control the refine

    TripResponseContext

    0:1

    +ResponseContext

    Context to hold objects, which are referenced within the response.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.31. The toplevel element OJPTripRefineDelivery

    OJPTripRefineDelivery

    +OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery)

    2.32. The complex type OJPTripRefineDeliveryStructure

    +

    OJPTripRefineDeliveryStructure

    siri:AbstractServiceDeliveryStructure

    2.35. The toplevel element OJPTripRefineDelivery

    OJPTripRefineDelivery

    +OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery)

    2.36. The complex type OJPTripRefineDeliveryStructure

    @@ -247,7 +265,7 @@

    OJP - Open API for distributed Journey

    -

    OJPTripRefineDeliveryStructure

    siri:AbstractServiceDeliveryStructure

    The element contains a sequence of the following elements:

    →‍OJPTripRefineRequest

    0:1

    →‍OJPTripRefineRequest

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

    identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems.

    TripResult

    0:*

    +TripResult

    The trip results refined by the server.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.33. The toplevel element OJPAvailabilityRequest

    OJPAvailabilityRequest

    +OJPAvailabilityRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.34. The complex type OJPAvailabilityRequestStructure

    +

    OJPAvailabilityRequestStructure

    +AbstractOJPServiceRequest

    2.37. The toplevel element OJPAvailabilityRequest

    OJPAvailabilityRequest

    +OJPAvailabilityRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.38. The complex type OJPAvailabilityRequestStructure

    @@ -259,7 +277,7 @@

    OJP - Open API for distributed Journey

    -

    OJPAvailabilityRequestStructure

    +AbstractOJPServiceRequest

    The element contains a sequence of the following elements:

    Then, 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.

    AvailabilityRequest

    Extension

    0:1

    xs:anyType

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.35. The toplevel element OJPAvailabilityDelivery

    OJPAvailabilityDelivery

    +OJPAvailabilityDelivery (↔ siri:AbstractFunctionalServiceDelivery)

    2.36. The complex type OJPAvailabilityDeliveryStructure

    +

    OJPAvailabilityDeliveryStructure

    siri:AbstractServiceDeliveryStructure

    2.39. The toplevel element OJPAvailabilityDelivery

    OJPAvailabilityDelivery

    +OJPAvailabilityDelivery (↔ siri:AbstractFunctionalServiceDelivery)

    2.40. The complex type OJPAvailabilityDeliveryStructure

    @@ -271,11 +289,11 @@

    OJP - Open API for distributed Journey

    -

    OJPAvailabilityDeliveryStructure

    siri:AbstractServiceDeliveryStructure

    The element contains a sequence of the following elements:

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

    identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems.

    Extension

    0:1

    xs:anyType

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.37. The toplevel element OJPLineInformationRequest

    OJPLineInformationRequest

    +OJPLineInformationRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.38. The complex type OJPLineInformationRequestStructure

    +

    OJPLineInformationRequestStructure

    +AbstractOJPServiceRequest

    2.41. The toplevel element OJPLineInformationRequest

    OJPLineInformationRequest

    +OJPLineInformationRequest (↔ siri:AbstractFunctionalServiceRequest)

    2.42. The complex type OJPLineInformationRequestStructure

    -

    OJPLineInformationRequestStructure

    +AbstractOJPServiceRequest

    The element contains a sequence of the following elements:

    LineDirectionFilter

    0:1

    +LineDirectionFilter

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    2.39. The toplevel element OJPLineInformationDelivery

    OJPLineInformationDelivery

    +OJPLineInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

    2.40. The complex type OJPLineInformationDeliveryStructure

    +

    OJPLineInformationDeliveryStructure

    siri:AbstractServiceDeliveryStructure

    2.43. The toplevel element OJPLineInformationDelivery

    OJPLineInformationDelivery

    +OJPLineInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

    2.44. The complex type OJPLineInformationDeliveryStructure

    @@ -307,7 +325,7 @@

    OJP - Open API for distributed Journey

    OJPLineInformationDeliveryStructure

    siri:AbstractServiceDeliveryStructure

    The element contains a sequence of the following elements:

    →‍OJPLineInformationRequest

    0:1

    →‍OJPLineInformationRequest

    LineInformationResponse

    LineResult

    0:*

    +LineResult

    FareResponse

    FareResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    FareResult

    0:*

    +FareResult

    Fare result choice element.

    4.8. The complex type FareResultStructure

    FareResultStructure

    Wrapper element for Fare results.

    The element contains a sequence of the following elements:

    Id

    1:1

    FareResultObjectId

    ID of this result.

    ErrorCondition

    0:*

    +OJPError

    Problems related to this FARE result.

    FareEstimated

    0:1

    xs:boolean

    Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, TravelClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE.

    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.9. 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.10. 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.11. 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

    Identifies the "valid from" trip.

    FromLegIdRef

    0:1

    LegObjectId

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

    ToTripIdRef

    1:1

    Identifies the "valid to" trip.

    ToLegIdRef

    0:1

    LegObjectId

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

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

    +

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

    5.1. Simple type definitions

    FareAuthorityGroup

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

    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.

    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

    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.

    5.5. The complex type TariffZoneRefStructure

    TariffZoneRefStructure

    Reference to a fare zone.

    5.6. The toplevel element TariffZoneRef

    TariffZoneRef

    +TariffZoneRef

    Reference to a fare zone.

    5.7. The complex type TariffZoneStructure

    TariffZoneStructure

    [a more clearly defined equivalent of TARIFF ZONE in TM and NeTEx] A ZONE used to define a zonal fare structure in a zone-counting or zone-matrix system.

    The element contains a sequence of the following elements:

    →‍TariffZoneRef

    1:1

    →‍TariffZoneRef

    Reference to a fare zone.

    TariffZoneText

    1:1

    xs:string

    Text describing the fare zone. Passengers will recognize the fare zone by this text. Often published on Fare Zone Maps.

    5.8. The complex type TariffZoneListInAreaStructure

    @@ -1418,7 +1436,7 @@

    OJP - Open API for distributed Journey

    TariffZoneListInAreaStructure

    List of fare zones within the area of a Fare Authority.

    The element contains a sequence of the following elements:

    BookableTicketAndServiceInformation

    BookableTicket

    0:*

    +FareProduct

    Sequence of bookable tickets or surcharges for this part of the trip. If ticket price is zero: an already purchased/virtual ticket of this type presented to the driver would be accepted.

    BookableServiceItem

    0:*

    +BookableServiceItem

    Sequence of bookable service items for this part of the trip.

    13.13. The complex type BookableServiceItemStructure

    BookableServiceItemStructure

    Possible service items that can be booked in the actual booking system (defined by the traffic company of charge). Only those elements with value greater 0 are bookable. The indicated capacity corresponds to the maximum number that can be booked in one booking. This number does not have to be available for the specific booking and may result in booking failure. Caution: list can vary widely from one traffic company to another.

    The element contains a sequence of the following elements:

    Type

    1:1

    BookableServiceItemType

    The type of bookable service.

    MaxBookableCapacity

    1:1

    xs:nonNegativeInteger

    Maximum number of service items that can be booked in one booking transaction. Default is 0.

    13.14. The toplevel element AvailabilityProblemType

    AvailabilityProblemType

    AvailabilityProblemType (↔ ErrorType)

    -

    14. OJP/OJP_Common.xsd - Supporting definitions of common structures

    14.1. Simple type definitions

    JourneyCodeType

    xs:NMTOKEN

    Identifier of a Journey

    ObjectIdType

    xs:normalizedString

    Type for identifier of a NeTEx Object.

    OperatingDayCodeType

    xs:NMTOKEN

    Identifier of an Operating Day

    OwnerCodeType

    xs:NMTOKEN

    identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE

    SharingModelEnumeration

    singleStationBased | multipleStationBased | nonStationBased

    Sharing service loan and return scheme.

    WeekdayTypeEnumeration

    Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | PublicHoliday

    [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays

    14.2. The toplevel element OJPError

    OJPError

    +OJPError (↔ siri:OtherError)

    Error: All OJP related errors.

    14.3. The complex type OJPErrorStructure

    +

    14. OJP/OJP_Common.xsd - Supporting definitions of common structures

    14.1. Simple type definitions

    OJPErrorStructure

    siri:OtherErrorStructure

    Type for Error: OJP Error.

    JourneyCodeType

    xs:NMTOKEN

    Identifier of a Journey

    ObjectIdType

    xs:normalizedString

    Type for identifier of a NeTEx Object.

    OperatingDayCodeType

    xs:NMTOKEN

    Identifier of an Operating Day

    OwnerCodeType

    xs:NMTOKEN

    identifier of ORGANISATION with ownership as the RESPONSIBILITY ROLE

    Percentage

    xs:decimal

    A percentage value between 0 and 100

    SharingModelEnumeration

    singleStationBased | multipleStationBased | nonStationBased

    Sharing service loan and return scheme.

    WeekdayTypeEnumeration

    Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | PublicHoliday

    [a specialisation of DAY OF WEEK in TMv6] enumeration of individual the seven DAYs OF WEEK, along with public holidays

    14.2. The toplevel element OJPError

    OJPError

    +OJPError (↔ siri:OtherError)

    Error: All OJP related errors.

    14.3. The complex type OJPErrorStructure

    @@ -1482,6 +1500,25 @@

    OJP - Open API for distributed Journey

    OJPErrorStructure

    siri:OtherErrorStructure

    Type for Error: OJP Error.

    The element contains a sequence of the following elements:

    →‍Error

    1:1

    →‍Error

    ProblemDetail

    Details

    0:1

    +InternationalText

    Explanation of the problem.

    MimeType

    0:1

    xs:normalizedString

    MIME type of the referenced resource. To which kind of resource does the URL point to?

    Embeddable

    0:1

    xs:boolean

    Is the referenced resource meant to be embedded as a webview in a surrounding context, e.g. app or web page? If yes, the resource has to be fully responsive. Default is false.

    +

    19. OJP/OJP_Status.xsd - OJP Status request and response

    19.1. Simple type definitions

    StatusProblemTypeEnumeration

    STATUS_INSTANCE_USAGE_DEPRECATED | STATUS_OTHER

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

    19.2. The toplevel element StatusProblemType

    StatusProblemType

    StatusProblemType (↔ ErrorType)

    19.3. The toplevel element OJPStatusResponse

    OJPStatusResponse

    +OJPStatusResponse (↔ siri:AbstractFunctionalServiceCapabilitiesResponse)

    19.4. The complex type OJPStatusResponseStructure

    + + + + + + + + + + + + +

    OJPStatusResponseStructure

    siri:AbstractServiceCapabilitiesResponseStructure

    The element contains a sequence of the following elements:

    ServiceResponseContext

    DataFrameRef

    0:1

    siri:DataFrameRefStructure

    identifier of the set of data being used by an information system, which allows a comparison to be made with the versions of data being used by overlapping systems.

    CalcTime

    0:1

    Calc

    Calculation time.

    ErrorCondition

    0:*

    +OJPError

    OJP generic problem for the whole delivery.

    OJPStatusResponse

    ServiceStarted

    0:1

    xs:dateTime

    Time when the service was started.

    ServiceReady

    0:1

    xs:dateTime

    Time when the service started responding to queries.

    LastTimetableUpdate

    0:1

    xs:dateTime

    Time when the timetable was last updated.

    ServerBuildVersion

    0:1

    xs:normalizedString

    Information about the server build.

    →‍siri:Extensions

    0:1

    →‍siri:Extensions

    19.5. The OJPStatusResponseGroup group

    + + + + +

    OJPStatusResponseGroup

    Status response group.

    OJPStatusResponse

    ServiceStarted

    0:1

    xs:dateTime

    Time when the service was started.

    ServiceReady

    0:1

    xs:dateTime

    Time when the service started responding to queries.

    LastTimetableUpdate

    0:1

    xs:dateTime

    Time when the timetable was last updated.

    ServerBuildVersion

    0:1

    xs:normalizedString

    Information about the server build.

    diff --git a/docs/schema-collection.xml b/docs/schema-collection.xml index 6c1987b77..6b2cc43e1 100644 --- a/docs/schema-collection.xml +++ b/docs/schema-collection.xml @@ -21,4 +21,5 @@ + diff --git a/examples/functions/status/OJPStatus_Request.xml b/examples/functions/status/OJPStatus_Request.xml new file mode 100644 index 000000000..082020fde --- /dev/null +++ b/examples/functions/status/OJPStatus_Request.xml @@ -0,0 +1,13 @@ + + + + + 2020-01-19T12:00:00Z + IRMA + + 2020-01-19T12:00:00Z + 4711 + + + + diff --git a/examples/functions/status/OJPStatus_Response.xml b/examples/functions/status/OJPStatus_Response.xml new file mode 100644 index 000000000..97b99329a --- /dev/null +++ b/examples/functions/status/OJPStatus_Response.xml @@ -0,0 +1,20 @@ + + + + + 2020-10-01T17:54:38Z + OJPCH_Prod + true + + 2020-10-01T17:54:38Z + 4711 + true + 20 + 2022-06-27T11:08:45Z + 2022-06-27T11:08:49Z + 2022-08-23T11:08:45Z + 12.2.1.2 (2022-05-03) + + + +