Open Journey Planner SDK for Android

Overview

This SDK is targeting Android applications seeking to integrate Open Journey Planner(OJP) 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”

Features

Available APIs:

• Location Information Request

Coming soon:

• Stop Event Request
• Trip Request
• TripInfo Request

Requirements

Compatible with Android 6+

Integration

• To integrate the SDK you have to add following repository in your root build.gradle:

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

• Now you can add the OJP dependency:

dependencies {
    implementation 'com.github.team-odmch:ojp-android:0.0.1'
}

Usage

Initializing

Initialize the SDK with your custom configuration:

OjpSdk(
    baseUrl = "Your Base URL",
    endpoint = "Your Endpoint",
    requesterReference = "Your Requester Reference",
    httpHeaders = hashMapOf(
    	"Authorization" to "Bearer myAccessToken",
    	"Custom-Header" to "CustomValue"
    )
)   

Basic Usage

• Get a list of locations from a keyword

import ch.opentransportdata.ojp.OjpSdk

requestLocationsFromSearchTerm(term = "Bern")                

• Get a list of Locations around a place with longitude and latitude

import ch.opentransportdata.ojp.OjpSdk

requestLocationsFromCoordinates(longitude = 5.6, latitude = 2.3)      

Documentation

Documentation of the Android SDK

Contributing

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

License

Apache License, see LICENSE

Contact

Create an issue or contact opentransportdata.swiss