OJP - Open API for distributed Journey Planning

OJP

-

@version

1:1

The element contains one of the following elements (a-b)

a

→‍OJPRequest

-1:1

+OJPRequest

OJP Request - Groups individual functional requests.

b

→‍OJPResponse

-1:1

+OJPResponse

OJP Request - Groups individual functional responses.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPRequest

+OJPRequest

OJP Request - Groups individual functional requests.

OJPResponse

+OJPResponse

OJP Request - Groups individual functional responses.

OJPRequestStructure

Type for OJP Request - Groups individual functional requests.

The element contains one of the following elements (a-d)

In case of choice 'a', the element contains one of the following elements (aa-ac)

aa

→‍siri:ServiceRequest

-1:1

+local-type: typedef-77.2

Request from Consumer to Producer for immediate delivery of data. Answered with a ServiceDelivery (or a DataReadyRequest)

ab

→‍siri:SubscriptionRequest

-1:1

+local-type: typedef-77.3

Request from Subscriber to Producer for a subscription. Answered with a SubscriptionResponse.

ac

→‍siri:TerminateSubscriptionRequest

-1:1

+siri:TerminateSubscriptionRequest

Request from Subscriber to Subscription Manager to terminate a subscription. Answered with a TerminateSubscriptionResponse.

In case of choice 'b', the element contains one of the following elements (ba-bb)

ba

→‍siri:DataReadyNotification

-1:1

+siri:DataReadyRequest

Request from Producer to Consumer to notify that data update is ready to fetch. Answered with a DataReadyResponse.

bb

→‍siri:DataSupplyRequest

-1:1

+siri:DataSupplyRequest

Request from Consumer to Producer to fetch update previously notified by a Data ready message. Answered with a Service Delivery.

In case of choice 'c', the element contains one of the following elements (ca-cb)

ca

→‍siri:CheckStatusRequest

-1:1

+siri:CheckStatusRequest

Request from Consumer to Producer to check whether services is working. Answers a CheckStatusRequest.

cb

→‍siri:HeartbeatNotification

-1:1

+siri:HeartbeatNotification

Notification from Producer to Consumer to indicate that the service is running normally.

In case of choice 'd', the element contains one of the following elements (da-db)

da

→‍siri:CapabilitiesRequest

-1:1

+siri:CapabilitiesRequest

Requests a the current capabilities of the server. Answred with a CpabailitiesResponse.

In case of choice 'db', the element contains one of the following elements (dba-dbh)

dba

→‍siri:StopPointsRequest

-1:1

+local-type: typedef-73.1

Requests a list of the STOP POINTs and places covered by a Producer.

dbb

→‍siri:LinesRequest

-1:1

+siri:LinesDiscoveryRequest

Requests a list of the LINEs covered by a Producer.

dbc

→‍siri:ServiceFeaturesRequest

-1:1

+local-type: typedef-73.2

Requests a list of the Service Features covered by a Producer.

dbd

→‍siri:ProductCategoriesRequest

-1:1

+siri:ProductCategoriesDiscoveryRequest

Requests a list of the Product Categories covered by a Producer.

dbe

→‍siri:VehicleFeaturesRequest

-1:1

+siri:VehicleFeaturesRequest

Requests a list of the Vehicle Features covered by a Producer.

dbf

→‍siri:InfoChannelRequest

-1:1

+siri:InfoChannelDiscoveryRequest

Requests a list of the Info Channels covered by a Producer.

dbg

→‍siri:FacilityRequest

-1:1

+siri:FacilityRequest

Requests a list of the Facilities covered by a Producer.

dbh

→‍siri:ConnectionLinksRequest

-1:1

+siri:ConnectionLinksDiscoveryRequest

Requests a list of the CONNECTION LINKs covered by a Producer. (since SIRI 2.0)

OJPResponseStructure

Type for OJP Response - Groups individual functional responses.

The element contains one of the following elements (a-d)

In case of choice 'a', the element contains one of the following elements (aa-ab)

aa

→‍siri:SubscriptionResponse

-1:1

+siri:SubscriptionResponse

Response from Producer to Consumer to inform whether subscriptions have been created. Answers a previous SubscriptionRequest.

ab

→‍siri:TerminateSubscriptionResponse

-1:1

+siri:TerminateSubscriptionResponse

Request from Subscriber to Subscription Manager to terminate a subscription. Answered with a TerminateSubscriptionResponse.

In case of choice 'b', the element contains one of the following elements (ba-bc)

ba

→‍siri:DataReadyAcknowledgement

-1:1

+siri:DataReadyResponse

Response from Consumer to Producer to acknowledge to Producer that a DataReadyRequest has been received.

bb

→‍siri:ServiceDelivery

-1:1

+local-type: typedef-77.4

Response from Producer to Consumer to deliver payload data. Either answers a direct ServiceRequest, or asynchronously satisfies a subscription. May be sent directly in one step, or fetched in response to a DataSupply Request.

bc

→‍siri:DataReceivedAcknowledgement

-1:1

+siri:DataReceivedResponse

Response from Consumer to Producer to acknowledge that data hase been received. Used as optioanl extra step if reliable delivery is needed. Answers a ServiceDelivery.

In case of choice 'c', the element contains one of the following elements (ca)

ca

→‍siri:CheckStatusResponse

-1:1

+siri:CheckStatusResponse

Response from Producer to Consumer to inform whether services is working. Answers a CheckStatusRequest.

In case of choice 'd', the element contains one of the following elements (da-db)

da

→‍siri:CapabilitiesResponse

-1:1

+siri:CapabilitiesResponse

Responses with the capabilities of an implementation.

In case of choice 'db', the element contains one of the following elements (dba-dbh)

dba

→‍siri:StopPointsDelivery

-1:1

+siri:StopPointsDelivery

Returns basic details about the STOP POINTs/places covered by a service. Answers a StopPointsRequest.

dbb

→‍siri:LinesDelivery

-1:1

+siri:LinesDelivery

Returns the LINEs covered by a web service. Answers a LINEsRequest.

dbc

→‍siri:ProductCategoriesDelivery

-1:1

+siri:ProductCategoriesDelivery

Returns the Product Categories covered by a service. Answers a ProductCategoriesRequest.

dbd

→‍siri:ServiceFeaturesDelivery

-1:1

+siri:ServiceFeaturesDelivery

Returns the SERVICE FEATUREs covered by a service. Answers a ServiceFeaturesRequest.

dbe

→‍siri:VehicleFeaturesDelivery

-1:1

+siri:VehicleFeaturesDelivery

Returns the Vehicle Features covered by a service. Answers a VehicleFeaturesRequest.

dbf

→‍siri:InfoChannelDelivery

-1:1

+siri:InfoChannelDelivery

Returns the Info Channels covered by a service. Answers a InfoChannelRequest.

dbg

→‍siri:FacilityDelivery

-1:1

+siri:FacilityDelivery

Returns the Facilities covered by a service. Answers a StopPointsRequest.

dbh

→‍siri:ConnectionLinksDelivery

-1:1

+siri:ConnectionLinksDelivery

Returns the CONNECTION LINKs covered by a web service. Answers a LINEsRequest. (since SIRI 2.0)

group[siri:ServiceDeliveryRequestStatusGroup]
  /ErrorCondition #complexType
  (typedef-50.1)

-

The element contains one of the following elements (a-b)

a

→‍siri:CapabilityNotSupportedError

-1:1

+siri:CapabilityNotSupportedError

Error: Service does not support the requested capability.

b

→‍siri:OtherError

-1:1

+siri:OtherError

Error: Error type other than the well defined codes.

siri:Description

0:1

>siri:ErrorDescription

Text description of error.

element[siri:StopPointsRequest]
  #complexType
  (typedef-73.1)

siri:StopPointsDiscoveryRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:AccountId

0:1

Account Identifier. May be used to attribute requests to a particular application provider and authentication key. The account may be common to all users of an application, or to an individual user. Note that to identify an individual user the RequestorRef can be used with an anonymised token. . (since SIRI 2.0)

siri:AccountKey

0:1

Authentication key for request. May be used to authenticate requests from a particular account. (since SIRI 2.0)

siri:Address

0:1

siri:EndpointAddress

Address to which response is to be sent. This may also be determined from RequestorRef and preconfigured data.

→‍siri:RequestorRef

1:1

>siri:ParticipantRef

Reference to a requestor - Participant Code.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique identifier that can be used to reference this message in subsequent interactions.

@version

1:1

siri:VersionString

Version number of request. Fixed

The element contains one of the following elements (a-c)

a

siri:BoundingBox

-0:1

+siri:BoundingBox

Rectangle containing stops be returned. ((since SIRI 2.0))

b

siri:Circle

-0:1

+siri:Location

Circle containing stops be returned. Point indicates centre, precision indicates radius ((since SIRI 2.0))

c

siri:PlaceRef

-0:1

Filter the results to include only stops associated with the PLACE . ((since SIRI 2.0))

siri:OperatorRef

0:1

>siri:OperatorRef

Filter the results to include only stops run by the specified OPERATOR. ((since SIRI 2.0))

siri:LineRef

0:1

>siri:LineRef

Filter the results to include only stops for the given LINE. ((since SIRI 2.0))

siri:Language

0:*

Preferred languages in which to return text values. (since SIRI 2.0)

siri:StopPointsDetailLevel

0:1

siri:StopPointsDetailEnumeration

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

→‍siri:Extensions

0:1

+siri:Extensions

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

element[siri:ServiceFeaturesRequest]
  #complexType
  (typedef-73.2)

siri:ServiceFeaturesDiscoveryRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:AccountId

0:1

Account Identifier. May be used to attribute requests to a particular application provider and authentication key. The account may be common to all users of an application, or to an individual user. Note that to identify an individual user the RequestorRef can be used with an anonymised token. . (since SIRI 2.0)

siri:AccountKey

0:1

Authentication key for request. May be used to authenticate requests from a particular account. (since SIRI 2.0)

siri:Address

0:1

siri:EndpointAddress

Address to which response is to be sent. This may also be determined from RequestorRef and preconfigured data.

→‍siri:RequestorRef

1:1

>siri:ParticipantRef

Reference to a requestor - Participant Code.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique identifier that can be used to reference this message in subsequent interactions.

@version

1:1

siri:VersionString

Version number of request. Fixed

→‍siri:Extensions

0:1

+siri:Extensions

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

element[siri:ServiceRequest]
  #complexType
  (typedef-77.2)

siri:ServiceRequest

Type for General SIRI Request.

siri:ServiceRequestContext

0:1

+siri:ServiceRequestContext

General request properties - typically configured rather than repeated on request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:AccountId

0:1

Account Identifier. May be used to attribute requests to a particular application provider and authentication key. The account may be common to all users of an application, or to an individual user. Note that to identify an individual user the RequestorRef can be used with an anonymised token. . (since SIRI 2.0)

siri:AccountKey

0:1

Authentication key for request. May be used to authenticate requests from a particular account. (since SIRI 2.0)

siri:Address

0:1

siri:EndpointAddress

Address to which response is to be sent. This may also be determined from RequestorRef and preconfigured data.

→‍siri:RequestorRef

1:1

>siri:ParticipantRef

Reference to a requestor - Participant Code.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique identifier that can be used to reference this message in subsequent interactions.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

element[siri:SubscriptionRequest]
  #complexType
  (typedef-77.3)

siri:SubscriptionRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:AccountId

0:1

Account Identifier. May be used to attribute requests to a particular application provider and authentication key. The account may be common to all users of an application, or to an individual user. Note that to identify an individual user the RequestorRef can be used with an anonymised token. . (since SIRI 2.0)

siri:AccountKey

0:1

Authentication key for request. May be used to authenticate requests from a particular account. (since SIRI 2.0)

siri:Address

0:1

siri:EndpointAddress

Address to which response is to be sent. This may also be determined from RequestorRef and preconfigured data.

→‍siri:RequestorRef

1:1

>siri:ParticipantRef

Reference to a requestor - Participant Code.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique identifier that can be used to reference this message in subsequent interactions.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

siri:ConsumerAddress

0:1

siri:EndpointAddress

Address to which data is to be sent, if different from Address. This may also be determined from RequestorRef and preconfigured data.

siri:SubscriptionFilterIdentifier

0:1

Reference to a Subscription Filter with which this subscription is to be aggregated for purposes of notification and delivery. If absent, use the default filter. If present, use any existing filter with that identifier, if none found, create a new one. Optional SIRI feature.

siri:SubscriptionContext

0:1

+siri:SubscriptionContext

General values that apply to subscription. Usually set by configuration.

→‍siri:AbstractFunctionalServiceSubscriptionRequest

1:*

+siri:AbstractSubscription

Subsititutable type for a SIRI Functional Service subscription request.

element[siri:ServiceDelivery]
  #complexType
  (typedef-77.4)

siri:ServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

siri:ProducerRef

0:1

>siri:ParticipantRef

Unique identifier of Producer - Participant reference.

siri:Address

0:1

siri:EndpointAddress

Endpoint Address to which acknowledgements to confirm delivery are to be sent.

siri:ResponseMessageIdentifier

0:1

>siri:MessageQualifier

An arbitrary unique reference associated with the response which may be used to reference it.

siri:RequestMessageRef

0:1

>siri:MessageRef

Reference to an arbitrary unique identifier associated with the request which gave rise to this response.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

@srsName

1:1

siri:SrsNameType

Default gml coordinate format for eny location elements in response; applies if Coordinates element is used to specify points. May be overridden on individual points.

siri:Status

0:1

Whether the complerte request could be processed successfully or not. Default is 'true'. If any of the individual requests within the delivery failed, should be set to ' false'.

siri:ErrorCondition

0:1

+local-type: typedef-50.1

Description of any error or warning conditions that appluy to the overall request. More Specific error conditions should be included on each request that fails.

siri:MoreData

0:1

Whether there is a further delvery message with more current updates that follows this one. Default is 'false'.

→‍siri:AbstractFunctionalServiceDelivery

1:*

+siri:AbstractServiceDelivery

Subsititutable type for a SIRI Functional Service request.

element[ojp:OJP]
  #complexType
  (typedef-105.1)

-

@version

1:1

The element contains one of the following elements (a-b)

a

→‍OJPRequest

-1:1

+OJPRequest

OJP Request - Groups individual functional requests.

b

→‍OJPResponse

-1:1

+OJPResponse

OJP Request - Groups individual functional responses.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPAvailabilityDelivery

+OJPAvailabilityDelivery (↔ siri:AbstractFunctionalServiceDelivery)

The availability service informs about the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY, or SINGLE JOURNEY. This service implements the models PI QR AM Vehicle Type Request and PI QR AM Mobility Service Request from TM 6.

OJPAvailabilityRequest

+OJPAvailabilityRequest (↔ siri:AbstractFunctionalServiceRequest)

The availability service informs about the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY, or SINGLE JOURNEY. This service implements the models PI QR AM Vehicle Type Request and PI QR AM Mobility Service Request from TM 6.

OJPExchangePointsDelivery

+OJPExchangePointsDelivery (↔ siri:AbstractFunctionalServiceDelivery)

Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner must find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. The boundary points where the trip calculation is handed over to the next journey planning system are called exchange points. If they are not known in advance the exchange points can be looked up from a server by using the exchange points service. This service implements the model PI QR Location Request from TM 6.

OJPExchangePointsRequest

+OJPExchangePointsRequest (↔ siri:AbstractFunctionalServiceRequest)

Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner must find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. The boundary points where the trip calculation is handed over to the next journey planning system are called exchange points. If they are not known in advance the exchange points can be looked up from a server by using the exchange points service. This service implements the model PI QR Location Request from TM 6.

OJPFareDelivery

+OJPFareDelivery (↔ siri:AbstractFunctionalServiceDelivery)

This service provides general, stop-specific and trip-specific fare information. This service implements the models PI Stop Fare Request, PI FQ Fare Product Request, PI FQ Single Trip Fare Request from TM 6.

OJPFareRequest

+OJPFareRequest (↔ siri:AbstractFunctionalServiceRequest)

This service provides general, stop-specific and trip-specific fare information. This service implements the models PI Stop Fare Request, PI FQ Fare Product Request, PI FQ Single Trip Fare Request from TM 6.

OJPLineInformationDelivery

+OJPLineInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

The service provides route information about a given LINE. This helps when displaying the LINE on maps. This implements a small part of PI QR Schedule Request of TM 6.

OJPLineInformationRequest

+OJPLineInformationRequest (↔ siri:AbstractFunctionalServiceRequest)

The service provides route information about a given LINE. This helps when displaying the LINE on maps. This implements a small part of model PI QR Schedule Request of TM 6.

OJPLocationInformationDelivery

+OJPLocationInformationDelivery (↔ siri:AbstractFunctionalServiceDelivery)

The Location Information service comprises the following four base functions: matching text input against possible origin and destination locations, retrieval of all location objects (bunch delivery), geographical context service that provides location objects within a bounding box, reverse address resolution service that delivers the nearest address for a given coordinate. By means of abstraction these functions are assembled within one single service – the Location Information service. This way, even more possible applications have arisen, such as: finding the nearest stops/stations for a given coordinate, matching text input against the names of locations near a given coordinate. This service implements the model PI QR Location Request from TM 6.

OJPLocationInformationRequest

+OJPLocationInformationRequest (↔ siri:AbstractFunctionalServiceRequest)

The Location Information service comprises the following four base functions: matching text input against possible origin and destination locations, retrieval of all location objects (bunch delivery), geographical context service that provides location objects within a bounding box, reverse address resolution service that delivers the nearest address for a given coordinate. By means of abstraction these functions are assembled within one single service – the Location Information service. This way, even more possible applications have arisen, such as: finding the nearest stops/stations for a given coordinate, matching text input against the names of locations near a given coordinate. This service implements the model PI QR Location Request from TM 6.

OJPMultiPointTripDelivery

+OJPMultiPointTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

This service provides intermodal trip information from multiple origin location to multiple destination taking various user preferences into account. In the case of OJPMultipointTripRequest it is a set of origins and destinations that are searched. This service implements the model PI QR Trip Request from TM 6.

OJPMultiPointTripRequest

+OJPMultiPointTripRequest (↔ siri:AbstractFunctionalServiceRequest)

This service provides intermodal trip information from multiple origin location to multiple destination taking various user preferences into account. In the case of OJPMultipointTripRequest it is a set of origins and destinations that are searched. This service implements the model PI QR Trip Request from TM 6.

OJPStatusDelivery

+OJPStatusDelivery (↔ siri:AbstractFunctionalServiceDelivery)

The status service provides basic information about the operational status of an OJP system.

OJPStatusRequest

+OJPStatusRequest (↔ siri:AbstractFunctionalServiceRequest)

The status service provides basic information about the operational status of an OJP system.

OJPStopEventDelivery

+OJPStopEventDelivery (↔ siri:AbstractFunctionalServiceDelivery)

This service provides information on arrivals and/or departures of public transport services from stops for a requested time or period of time. Restrictions can be set in the request parameters that filter the result contents accordingly. This service implements PI QR Stop Event Request from TM 6

OJPStopEventRequest

+OJPStopEventRequest (↔ siri:AbstractFunctionalServiceRequest)

This service provides information on arrivals and/or departures of public transport services from stops for a requested time or period of time. Restrictions can be set in the request parameters that filter the result contents accordingly. This service implements the model PI QR Stop Event Request from TM 6

OJPTripChangeDelivery

+OJPTripChangeDelivery (↔ siri:AbstractFunctionalServiceDelivery)

A trip can be modified in a limited manner by specifying a longer time duration for a specific interchange or by specifying an estimated leg for which the exact time information shall be retrieved. In both cases, earlier or later legs of the trip may be recalculated as well.

OJPTripChangeRequest

+OJPTripChangeRequest (↔ siri:AbstractFunctionalServiceRequest)

A trip can be modified in a limited manner by specifying a longer time duration for a specific interchange or by specifying an estimated leg for which the exact time information shall be retrieved. In both cases, earlier or later legs of the trip may be recalculated as well.

OJPTripDelivery

+OJPTripDelivery (↔ siri:AbstractFunctionalServiceDelivery)

This service provides intermodal trip information from an origin location to a destination taking various user preferences into account. In the case of OJPTripRequest it is single origin and a single destination that are searched. This service implements the model PI QR Trip Request from TM 6.

OJPTripInfoDelivery

+OJPTripInfoDelivery (↔ siri:AbstractFunctionalServiceDelivery)

This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't directly provide information about a trip. If the response changes the conditions in such a way that the trip becomes invalid (connection no longer possible, delay, cancellation), a new TripRequest is required for the remainder of the trip. The service also provides information about formation, occupancy, and capacity. The full SIRI elements are used. Therefore, a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6.

OJPTripInfoRequest

+OJPTripInfoRequest (↔ siri:AbstractFunctionalServiceRequest)

This service provides information on a single leg (service pattern, real-time status, vehicle facilities etc.). The service always provides information about a VEHICLE or a SERVICE JOURNEY. It doesn't directly provide information about a trip. If the response changes the conditions in such a way that the trip becomes invalid (connection no longer possible, delay, cancellation), a new TripRequest is required for the remainder of the trip. The service also provides information about formation, occupancy, and capacity. The full SIRI elements are used. Therefore, a lot of things can be expressed. Some that go beyond what usually may be required. However, if accessibility is fully to be considered (with stop-vehicle interaction), then SIRI must be used in full. The relevant SIRI documentation should be considered. This service implements PI QR Service Journey Request and PI QR Single Journey Request from TM 6.

OJPTripRefineDelivery

+OJPTripRefineDelivery (↔ siri:AbstractFunctionalServiceDelivery)

The trip refinement service retrieves additional or updated information (e.g., real-time data) about a given, previously retrieved trip. It does not depend on the assumption that the trip has been retrieved from the same server; it may, in fact, even stem from another source than a OJP system. An example scenario may involve a trip retrieved from a system A and one wishes to refine the trip with real time information from another system B. As it cannot be ascertained that both systems use identical object IDs, this is signalled by setting ExternalObjectRefs to true. System B, being confronted with external IDs, must try to recognise the relevant objects in another way and retrieve them in its own database. In the response it will use its own object IDs. To maintain a consistent mapping, it is imperative that system B reflects the structure of the refine request precisely in its response (principle of structure maintenance).

OJPTripRefineRequest

+OJPTripRefineRequest (↔ siri:AbstractFunctionalServiceRequest)

The trip refinement service retrieves additional or updated information (e.g., real-time data) about a given, previously retrieved trip. It does not depend on the assumption that the trip has been retrieved from the same server; it may, in fact, even stem from another source than a OJP system. An example scenario may involve a trip retrieved from a system A and one wishes to refine the trip with real time information from another system B. As it cannot be ascertained that both systems use identical object IDs, this is signalled by setting ExternalObjectRefs to true. System B, being confronted with external IDs, must try to recognise the relevant objects in another way and retrieve them in its own database. In the response it will use its own object IDs. To maintain a consistent mapping, it is imperative that system B reflects the structure of the refine request precisely in its response (principle of structure maintenance).

OJPTripRequest

+OJPTripRequest (↔ siri:AbstractFunctionalServiceRequest)

This service provides intermodal trip information from an origin location to a destination taking various user preferences into account. In the case of OJPMultipointTripRequest it is a set of origins and destinations that are searched. This service implements the model PI QR Trip Request from TM 6.

OJPAvailabilityDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

AvailabilityResponseContext

0:1

+ResponseContext

Context to hold availability response objects that occur frequently.

AvailabilityResult

0:1

+AvailabilityResult

Indication of the availability of the requested service.

Extension

0:1

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPAvailabilityRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

The element contains one of the following elements (a)

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.

EarliestDepartureTime

0:1

Earliest possible departure time from start location.

LatestArrivalTime

0:1

Latest possible arrival time at destination location.

Extension

0:1

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPExchangePointsDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

→‍OJPExchangePointsRequest

0:1

+OJPExchangePointsRequest

Distributed journey planning requires several journey planning systems planning parts of the whole trip which shall be assembled. Each of the planners will therefore get a sub-query to plan: the first planner from the origin of the trip to its system boundaries, the next planner must find trips from these boundaries to its boundaries with the next systems. This process will be continued until the final system where the destination of the user’s trip is located. The boundary points where the trip calculation is handed over to the next journey planning system are called exchange points. If they are not known in advance the exchange points can be looked up from a server by using the exchange points service. This service implements the model PI QR Location Request from TM 6.

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

ExchangePointsResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

ContinueAt

0:1

If the response returns fewer results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.

ExchangePointsResult

0:*

+ExchangePointsResult

The exchange points found by the service.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPExchangePointsRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

PlaceRef

0:1

+PlaceRef

Location/Place for which exchange points to other "neighbour" systems are to be searched. This location/place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.

Params

0:1

+ExchangePointsParam

E.g. location/place types (stops, addresses, POIs) or specific location/place attributes

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPFareDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

FareResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

FareResult

0:*

+FareResult

Fare result choice element.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPFareRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

The element contains one of the following elements (a-e)

a

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related FARE information.

b

PlaceFareRequest

-1:1

+PlaceFareRequest

A request for place-related FARE information.

c

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static FARE information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the FARE information of a single trip.

e

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated FARE information of multiple single trips.

Params

0:1

+FareParam

Parameter to filter the response contents.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPLineInformationDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

→‍OJPLineInformationRequest

0:1

+OJPLineInformationRequest

The service provides route information about a given LINE. This helps when displaying the LINE on maps. This implements a small part of model PI QR Schedule Request of TM 6.

LineResult

0:*

+LineResult

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPLineInformationRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

LineDirectionFilter

0:1

+LineDirectionFilter

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPLocationInformationDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

→‍OJPLocationInformationRequest

0:1

+OJPLocationInformationRequest

The Location Information service comprises the following four base functions: matching text input against possible origin and destination locations, retrieval of all location objects (bunch delivery), geographical context service that provides location objects within a bounding box, reverse address resolution service that delivers the nearest address for a given coordinate. By means of abstraction these functions are assembled within one single service – the Location Information service. This way, even more possible applications have arisen, such as: finding the nearest stops/stations for a given coordinate, matching text input against the names of locations near a given coordinate. This service implements the model PI QR Location Request from TM 6.

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

LocationInformationResponseContext

0:1

+ResponseContext

Context to hold response objects that occur frequently.

ContinueAt

0:1

If the response returns fewer results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.

PlaceResult

0:*

+PlaceResult

The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPLocationInformationRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

The element contains one of the following elements (a-b)

a

InitialInput

-1:1

+InitialLocationInput

Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs.

b

PlaceRef

-1:1

+PlaceRef

LOCATION / PLACE for further refinement. If a Place in a previous response was marked as not "complete" it can be refined by putting it here. If Places are organised hierarchically, it may be reasonable to identify the Place in a top-down approach with several steps of refining a Place on each level of hierarchy. Following this approach an initial request retrieves a first list of top-level Places (e.g., streets) which are to be refined in a subsequent request to the next level (e.g., house number intervals). The objects of the current level are presented to the user for selection. The object reference of the selected object is then sent in the next request for further refinement.

Restrictions

0:1

+PlaceParam

E.g. place types (stops, addresses, POIs) or specific place attributes

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPMultiPointTripDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

→‍OJPMultiPointTripRequest

0:1

+OJPMultiPointTripRequest

This service provides intermodal trip information from multiple origin location to multiple destination taking various user preferences into account. In the case of OJPMultipointTripRequest it is a set of origins and destinations that are searched. This service implements the model PI QR Trip Request from TM 6.

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

MultiPointType

0:1

MultiPointTypeEnumeration

The MultiPointType should be returned because it may differ from the one asked. Many systems will support only a subset of the MultiPointTypes, and it is important to know what the result is based on.

MultiPointTripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

MultiPointTripResult

0:*

+MultiPointTripResult

The trip results found by the server.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPMultiPointTripRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

Origin

1:*

+PlaceContext

Specifies the origin situation from where the user wants to start.

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops (in Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia).

NotVia

0:*

+NotVia

Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.

NoChangeAt

0:*

+NoChangeAt

no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP (in Transmodel this would be an extension to TRIP MOBILITY FILTER).

Params

0:1

+MultiPointTripParam

Options to control the search behaviour and response contents.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPStatusDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

→‍OJPStatusRequest

0:1

+OJPStatusRequest

The status service provides basic information about the operational status of an OJP system.

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

ServiceStarted

0:1

Time when the service was started.

ServiceReady

0:1

Time when the service started responding to queries.

LastTimetableUpdate

0:1

Time when the timetable was last updated.

ServerBuildVersion

0:1

Information about the server build.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPStatusRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPStopEventDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

→‍OJPStopEventRequest

0:1

+OJPStopEventRequest

This service provides information on arrivals and/or departures of public transport services from stops for a requested time or period of time. Restrictions can be set in the request parameters that filter the result contents accordingly. This service implements the model PI QR Stop Event Request from TM 6

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

StopEventResponseContext

0:1

+ResponseContext

Container for data that is referenced multiple times.

StopEventResult

0:*

+StopEventResult

Enclosing element for stop event data.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPStopEventRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

Location

1:1

+PlaceContext

LOCATION / PLACE for which to obtain stop event information. If a coordinate or an address is used, then the result may depend on other parameters: All stops in reasonable walking distance and stops that are within range of limitations of the IndividualTransportOptions should be shown. If the next stop is too far away, then no result is shown. "Reasonable" is usually defined as part of the server configuration.

Params

0:1

+StopEventParam

Request parameter

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPTripChangeDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

→‍OJPTripChangeRequest

0:1

+OJPTripChangeRequest

A trip can be modified in a limited manner by specifying a longer time duration for a specific interchange or by specifying an estimated leg for which the exact time information shall be retrieved. In both cases, earlier or later legs of the trip may be recalculated as well.

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:1

+TripResult

The trip results refined by the server.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPTripChangeRequestStructure

AbstractOJPServiceRequest

Type for General SIRI Request.

→‍siri:RequestTimestamp

1:1

Timestamp on request.

siri:MessageIdentifier

0:1

>siri:MessageQualifier

Arbitrary unique reference to this message.

DataFrameRef

0:1

>siri:DataFrameRef

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

ChangeParams

0:1

+TripChangeParam

Options to control the change.

TripResult

1:1

+TripResult

The trip result to be changed by the server.

TripResponseContext

0:1

+ResponseContext

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

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPTripDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1

End of data horizon of the data producer.

siri:ShortestPossibleCycle

0:1

siri:PositiveDurationType

Minimum interval at which updates can be sent.

siri:DefaultLanguage

0:1

Default language for text elements.

→‍OJPTripRequest

0:1

+OJPTripRequest

This service provides intermodal trip information from an origin location to a destination taking various user preferences into account. In the case of OJPMultipointTripRequest it is a set of origins and destinations that are searched. This service implements the model PI QR Trip Request from TM 6.

DataFrameRef

0:1

>siri:DataFrameRef

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

CalcTimeType

Calculation time.

ErrorCondition

0:*

+OJPError

OJP generic problem for the whole delivery.

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:*

+TripResult

The trip results found by the server.

→‍siri:Extensions

0:1

+siri:Extensions

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

OJPTripInfoDeliveryStructure

siri:AbstractServiceDelivery

General Type for General SIRI Response.

→‍siri:ResponseTimestamp

1:1

Time individual response element was created.

The element contains one of the following elements (a) or element sequences (b)

a

siri:RequestMessageRef

-0:1

>siri:MessageRef

Arbitrary unique reference to the request which gave rise to this message.

b

siri:SubscriberRef

-0:1

>siri:ParticipantRef

Unique identifier of Subscriber - reference to a Participant.

b

siri:SubscriptionFilterRef

-0:1

>siri:SubscriptionFilterRef

Unique identifier of Subscription filter to which this subscription is assigned. If there is onlya single filter, then can be omitted.

b

siri:SubscriptionRef

-1:1

>siri:SubscriptionRef

Reference to a service subscription: unique within Service and Subscriber.

siri:DelegatorAddress

0:1

siri:EndpointAddress

Address of original Consumer, i.e. requesting system to which delegating response is to be returned. (since SIRI 2.0)

siri:DelegatorRef

0:1

>siri:ParticipantRef

Identifier of delegating system that originated message. (since SIRI 2.0)

→‍siri:Status

0:1

Whether the request was processed successfully or not. Default is 'true'.

siri:ErrorCondition

0:1

+siri:ServiceDeliveryErrorCondition

Description of any error or warning condition.

siri:ValidUntil

0:1