diff --git a/README.md b/README.md index a5e9d7f6e..6d48eaa8a 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,39 @@ -# OJP - *O*pen API for distributed *J*ourney *P*lanning +# OJP - *O*pen API for distributed *J*ourney *P*lanning XSD -OJP initiative was born to answer the exigence to exchange accurate and timely information about public transport (PT) services and to -implement systems able to provide Multi-modal information for longer-distance journeys. +## Content ## +This repository contains the XSD and examples for the Standard "CEN/TS 17118:2017: "Intelligent transport systems - Public transport - Open API for distributed journey planning". -Several systems have been developed to answer to this requirement, based on different architectures, but the nature of the enquiries sent -between the systems, and the content of the responses sent in return, were essentially the same. This suggested that it would be possible -to define a single Open Journey Planning API to support all distributed journey planning systems. +OJP consists of a set of services that can be addressed by Request / Response or by subscription. -OJP allows a system to engineer just one interface that it can make available rather than having to engineer separate APIs for each bipartite -exchange arrangement that may be required with other systems. +The main services are: +* Location Information +* Stop Events (arrival and departure boards) +* Searching for Trips +* Information about a given Trips +* Information about Fares for Trips -The establishment of Open APIs has been enabled by increasingly standardised in Public Transport by following the principles set out in -the "Public Transport Reference Data Model" (Transmodel) EN standard, and its related implementation Standards and specifications. +For the interaction between different OJP additionally there are: +* Getting information about Exchange Points (places when a Trip switches from one OJP system to another) +* MultiPointTripRequest: Allows for searching of n x m Trips + + +## Standard document + +Obtain a copy of the standard document +["CEN/TS 17118:2017: "Intelligent transport systems - Public transport - Open API for distributed journey planning"](https://standards.cen.eu/dyn/www/f?p=204:110:0::::FSP_PROJECT:62236&cs=1985DBD613F25D179FB65A73B0FDA4DB7) +at [CEN](https://www.cen.eu). + +## Repository + +Download the XSD schema files and examples in the git repository found at https://github.com/VDVde/OJP + +## Regulatory environment of OJP ## The ITS Directive Delegated Regulation for provision of EU-wide multimodal travel information services is the legal framework for travel data access and distributed journey planning in Europe. This initiative will provide the necessary requirements to make EU-wide multimodal travel information services accurate and available across borders. One of the key requirements concerns linking travel information services for distributed journey planning. Upon request, travel information service providers shall provide to another information service provider "routing results" based on static, and where possible, dynamic information. The "routing results" shall be based on: - * the enquirers start and end points of a journey along with the specific time and date of departure or arrival, or both; * possible travel options along with the specific time and date of departure or arrival, or both, including any possible connections; * the handover point between travel information services; @@ -27,13 +42,3 @@ for distributed journey planning. Upon request, travel information service provi The Delegated Regulation recommends that the CEN OPEN API standard for distributed journey planning is used by local, regional and national travel information service providers. - -## Standard document - -Obtain a copy of the standard document -["CEN/TS 17118:2017: "Intelligent transport systems - Public transport - Open API for distributed journey planning"](https://standards.cen.eu/dyn/www/f?p=204:110:0::::FSP_PROJECT:62236&cs=1985DBD613F25D179FB65A73B0FDA4DB7) -at [CEN](https://www.cen.eu). - -## Repository - -Download the XSD schema files and examples in the git repository found at https://github.com/VDVde/OJP