@datafire/deutschebahn_flinkster

Client library for Flinkster_API_NG

Installation and Usage

npm install --save @datafire/deutschebahn_flinkster

let deutschebahn_flinkster = require('@datafire/deutschebahn_flinkster').create();

.then(data => {
  console.log(data);
});

Description

This REST-API enables you to query for private transport sharing offers provided by companies and cities in Germany, Netherland and Austria. You can search for informations about the rental stations (points or areas) where you can find the rentals by utilizing the /areas/ ressource. With the help of the proximity search in the /bookingproposals/ URI you can request the availabilities of the rentalobjects for spontaneous or planed usage in the future.

Feel free to browse through data by setting the parameter 'providernetwork' to the value: 1: Search for car sharing offers provided by the Flinkster platform (http://www.flinkster.de) 2: Finding bike rental offers from Call a Bike (http://www.callabike.de)

You can find more details in the documentation section (Unfortunately only available in german language).

Have lots of fun and we are lucky to take notice of your products or getting your feedback.

Actions

listAreas

Search for areas (locations of rental objects) by criteria.

deutschebahn_flinkster.listAreas({}, context)

Input

• input object
  • lat number
  • lon number
  • radius integer
  • offset integer
  • limit integer
  • expand string
  • type string
  • provider string
  • providernetwork string

Output

• output AreaJO

getArea

Search for a specific area by UID.

deutschebahn_flinkster.getArea({
  "areaUID": ""
}, context)

Input

• input object
  • areaUID required string: The Area UID
  • expand string: Expand Provider

Output

• output AreaJO

listBookingProposals

Here you can query all bookable Rental Objects with different Parameters (Time, Location,...)

deutschebahn_flinkster.listBookingProposals({}, context)

Input

• input object
  • lat number
  • lon number
  • radius integer
  • offset integer
  • limit integer
  • providernetwork string
  • begin string
  • end string
  • expand string
  • view string

Output

• output RentalObjectJO

getIndex

Show Service index.

deutschebahn_flinkster.getIndex(null, context)

Input

This action has no parameters

Output

• output JsonCollection

listCategories

Search for categorie.

deutschebahn_flinkster.listCategories({
  "providernetworkUID": ""
}, context)

Input

• input object
  • providernetworkUID required string
  • expand string

Output

• output CategoryJO

getCategory

Search for categorie.

deutschebahn_flinkster.getCategory({
  "providernetworkUID": "",
  "categoryUID": ""
}, context)

Input

• input object
  • providernetworkUID required string: Provider Network UID
  • categoryUID required string
  • expand string

Output

• output CategoryJO

getPrices

Prices of a rental object by query params. The params depend on the price determination strategy of the provider network.

deutschebahn_flinkster.getPrices({
  "providernetworkUID": ""
}, context)

Input

• input object
  • providernetworkUID required string

Output

• output RentalObjectJO

getRentalObject

Get information about the Rental Object.

deutschebahn_flinkster.getRentalObject({
  "rentalObjectUID": "",
  "providernetworkUID": ""
}, context)

Input

• input object
  • rentalObjectUID required string
  • providernetworkUID required string
  • expand string

Output

• output RentalObjectJO

getProviderNetwork

Get information about the ProviderNetworkResources.

deutschebahn_flinkster.getProviderNetwork({
  "uid": ""
}, context)

Input

• input object
  • uid required string

Output

• output RentalObjectJO

getProvider

Get information about the ProviderResourcesCtrl.

deutschebahn_flinkster.getProvider({
  "uid": ""
}, context)

Input

• input object
  • uid required string

Output

• output RentalObjectJO

Definitions

AddressJO

• AddressJO object
  • city string
  • district string
  • isoCountryCode string
  • number string
  • street string
  • zip string

AreaJO

• AreaJO object
  • _links array
    • items LinkJO
  • address AddressJO
  • attributes object
  • description string
  • expand string
  • geometry GeometryJO
  • href string
  • name string
  • provider ProviderJO
  • providerAreaId string
  • providerNetworkIds array
    • items integer
  • type string (values: STATION, OPERATIONAREA, PARKINGAREA, GASSTATION, UNKNOWN)
  • uid string

BookingProposalJO

• BookingProposalJO object
  • _links array
    • items LinkJO
  • area AreaJO
  • attributes object
  • description string
  • distance number
  • expand string
  • href string
  • name string
  • position GeoJsonObject
  • price JsonCollectionPriceJO
  • rentalObject RentalObjectJO
  • uid string

CategoryJO

• CategoryJO object
  • _links array
    • items LinkJO
  • attributes object
  • description string
  • expand string
  • href string
  • name string
  • price array
    • items PriceJO
  • uid string

Crs

• Crs object
  • properties object
  • type string (values: name, link)

ErrorJO

• ErrorJO object
  • attributes object
  • code integer
  • level string (values: INFO, WARNING, ERROR)
  • message string
  • name string

Feature

• Feature object
  • bbox array
    • items number
  • crs Crs
  • geometry GeoJsonObject
  • id string
  • properties object

FeatureCollection

• FeatureCollection
  • bbox array
    • items number
  • crs Crs
  • features array
    • items Feature

GeoJsonObject

• GeoJsonObject object
  • bbox array
    • items number
  • crs Crs

GeometryJO

• GeometryJO object
  • centroid Point
  • position GeoJsonObject

JsonCollection

• JsonCollection object
  • _links array
    • items LinkJO
  • href string
  • items array
    • items JsonObject
  • limit integer
  • offset integer
  • size integer

JsonCollectionPriceJO

• JsonCollectionPriceJO object
  • _links array
    • items LinkJO
  • href string
  • items array
    • items PriceJO
  • limit integer
  • offset integer
  • size integer

JsonObject

• JsonObject object
  • _links array
    • items LinkJO
  • attributes object
  • description string
  • expand string
  • href string
  • name string
  • uid string

LineString

• LineString
  • bbox array
    • items number
  • crs Crs

LinkJO

• LinkJO object
  • href string
  • rel string
  • verb string

LngLatAlt

• LngLatAlt object
  • altitude number
  • latitude number
  • longitude number

MultiLineString

• MultiLineString
  • bbox array
    • items number
  • crs Crs
  • coordinates array
    • items array
      • items LngLatAlt

MultiPoint

• MultiPoint
  • bbox array
    • items number
  • crs Crs
  • coordinates array
    • items LngLatAlt

MultiPolygon

• MultiPolygon
  • bbox array
    • items number
  • crs Crs
  • coordinates array
    • items array
      • items array
        • items LngLatAlt

Point

• Point object
  • bbox array
    • items number
  • coordinates LngLatAlt
  • crs Crs

Polygon

• Polygon
  • bbox array
    • items number
  • crs Crs
  • coordinates array
    • items array
      • items LngLatAlt

PriceJO

• PriceJO object
  • _links array
    • items LinkJO
  • attributes object
  • currency string
  • description string
  • expand string
  • grossamount number
  • href string
  • interval integer
  • name string
  • preferredprice boolean
  • taxrate number
  • type string (values: TIME, DISTANCE)
  • uid string

ProviderJO

• ProviderJO object
  • _links array
    • items LinkJO
  • attributes object
  • description string
  • expand string
  • href string
  • name string
  • uid string

RentalObjectJO

• RentalObjectJO object
  • _links array
    • items LinkJO
  • attributes object
  • category CategoryJO
  • description string
  • expand string
  • href string
  • name string
  • provider ProviderJO
  • providerNetworkIds array
    • items integer
  • providerRentalObjectId string
  • rentalModel string (values: FREEFLOATING, FREEFLOATINGWITHSTATION, STATIONBASED, PARKINGAREA, UNKNOWN)
  • type string (values: VEHICLE, VEHICLEPOOL, BIKE, PEDELEC, UNKNOWN)
  • uid string