Skip to content

Latest commit

 

History

History
165 lines (107 loc) · 5.82 KB

README.md

File metadata and controls

165 lines (107 loc) · 5.82 KB
Raw

Open Journey Planner SDK for iOS

Overview

This SDK is targeting iOS applications seeking to integrate Open Journey Planner (OJP) V2 APIs to support distributed journey planning according to the European (CEN) Technical Specification entitled “Intelligent transport systems – Public transport – Open API for distributed journey planning”.

For a general introduction to `OJP, consult the Cookbook on opentransportdata.swiss. Visit vdvde.github.io/OJP for the documentation of the XML Schema of OJP.

🚧 Currently this SDK is under construction. There is not yet a stable version and the APIs may change. 🚧

Features

Available APIs

Soon to be available

Requirements

  • Compatible with: iOS 15+ and macOS 14+

Installation

  • The SDK can be integrated into your Xcode project using the Swift Package Manager. To do so, just add the package by using the following: https://github.com/openTdataCH/ojp-ios.git

Usage

Initializing

TBA

  • endpoints configuration
  • requesterReference
  • authBearerToken - where to get it from
import OJP

let apiConfiguration = APIConfiguration(
    apiEndPoint: URL(string: "your api endpoint")!, 
    requesterReference: "your request reference", 
    additionalHeaders: [
        "Authorization": "Bearer yourBearerToken"
        ]
    )

let ojpSdk = OJP(
    loadingStrategy: .http(apiConfiguration),
    language: "de" // optional ISO language code. Defaults to the preferred localization. 
    )

Basic Usage

Get a list of PlaceResults from a keyword

import OJP
        
// get only stops
let stops = try await ojpSdk.requestPlaceResults(from: "Bern", restrictions: .init(type: [.stop]))
        
// get stops and addresses
let addresses = try await ojpSdk.requestPlaceResults(from: "Bern", restrictions: .init(type: [.stop, .address]))

Get a List of PlaceResults around a Place using Longitude and Latitude

import OJP

let nearbyStops = try await ojpSdk.requestPlaceResults(from: Point(long: 5.6, lat: 2.3), restrictions: .init(type: [.stop])

Get a List of Trips between two Places

import OJP

let origin = try await ojpSdk.requestPlaceResults(from: "Bern", restrictions: .init(type: [.stop])).first!

let via = try await ojpSdk.requestPlaceResults(from: "Luzern", restrictions: .init(type: [.stop])).first!

let destination = try await ojpSdk.requestPlaceResults(from: "Zurich HB", restrictions: .init(type: [.stop])).first!

let tripDelivery = try await ojp.requestTrips(from: origin.placeRef, to: destination.placeRef, via: via.placeRef, params: .init(includeTrackSections: true, includeIntermediateStops: true))

Use PaginatedTripLoader to load previous and upcoming TripResults

// create a new PaginatedTripLoader
let paginatedActor = PaginatedTripLoader(ojp: ojp)

// load the initial trips
let tripRequest = TripRequest(from: origin.placeRef,
                              to: destination.placeRef,
                              via: via != nil ? [via!.placeRef] : nil,
                              at: .departure(Date()),
                              params: .init(
                                  includeTrackSections: true,
                                  includeIntermediateStops: true
                                  )
                              )
let tripDelivery = try await paginatedActor!.loadTrips(for: tripRequest,
                                    numberOfResults: .minimum(6))
let tripResults = tripDelivery.tripResults

// load previous TripResults
let previousTripResults = try await paginatedActor.loadPrevious().tripResults

// load future TripResults
let nextTripResults = try await paginatedActor.loadPrevious().tripResults

Load informations to a trip using TripInformationRequest

let journeyRef = timedLeg.service.journeyRef
let operatingDayRef = timedLeg.service.operatingDayRef

let tripInfo = try await OJP.configured.requestTripInfo(
    journeyRef: journeyRef,
    operatingDayRef: operatingDayRef,
    params: .init(useRealTimeData: .explanatory)
)

Sample App

There is an experimental Sample App to showcase and test the SDK. Currently intended to be run as a macOS app.

Documentation

Releases

See Releases for the history of all current releases.

A new release can be prepared using ./create-version.sh.

Used Standards

Contributing

Contributions are welcomed. Feel free to create an issue or a feature request, or fork the project and submit a pull request.

License

MIT License, see LICENSE

Contact

Create an issue or contact opentransportdata.swiss