FluidHub Mobility Service Provider API (v2.4.52)

Download OpenAPI specification:Download

Fluidtime provides a full-fledged open MaaS Platform. FluidHub acts as a standardization layer, harmonizing data from multiple Transport Service Providers (TSPs), providing it to Mobility Service Providers (MSPs) and thus enabling seamless access to locally-available transportation offerings. The open APIs provides REST endpoints for Mobility Service Provider (MSP) to integrate the service into their ecosystem. It is intended to be used by server-side services.

This API produces and consumes application/json as specified in RFC 7159.

All date and time values are in UTC. Date, time and duration values are represented according to ISO 8601. This api does not support the 24:00:00 notation of time values. Time is allowed to be at a maximum of 23:59:59, not 24:00:00.

Geographic coordinates are referencing the WGS 84.

Polylines are encoded and represented according to Encoded Polyline Algorithm Format

HTTP 1.1 ETag: All calls are subjects to cache handling as specified in RFC 7232.

Caching of responses is achieved by the HTTP 1.1 ETag mechanism and only affects responses which are allowed to be cached.

For Booking related calls, clients should set a read timeout of at least 15 seconds.

Used abbreviations:

  • Transport Service Provider (TSP)
  • Mobility Service Provider (MSP)
  • Mobility Service Consumer (MSC)

Authentication

MSP

Authentication of a client via an API key sent in the Authorization header. Header value is ignored if authorization is not required by the called API.

Security scheme type: API Key
header parameter name: Authorization

Route

Get a route with multiple trip suggestions

Returns suggestions for possible trips to accomplish the requested route request. Each trip represents an alternative to choose from. A trip may be divided into legs by using defined waypoints between legs.

The main properties of a trip are origin and destination. leg in destination describes the way from the last waypoint to the destination. If no waypoints are set, this leg describes the way from origin to destination.

Each waypoint contains a leg that describes the way from the previous waypoint (if available, otherwise from origin) to the waypoint itself.

All trips contain a simplified encoded polyline. The legs' polylines are more detailed.

Authorizations:
path Parameters
mspId
required
string^[a-zA-Z0-9_-]{1,16}$
x-excludeInSignature: true

Id selecting the MSP configuration to use.

query Parameters
oLatLng
required
string^[-+]?([1-8]?\d(\.\d{0,7})?|90(\.0{0,7})?),[-+]?(180(\.0{0,7})?|((1[0-7]\d)|([1-9]?\d))(\.\d{0,7})?)$

Origin coordinate represented by a "lat,lon" in the format "[-90,90],[-180,180]" allowing a numeric format with a maximum precision of 7 decimal digits.

dLatLng
required
string^[-+]?([1-8]?\d(\.\d{0,7})?|90(\.0{0,7})?),[-+]?(180(\.0{0,7})?|((1[0-7]\d)|([1-9]?\d))(\.\d{0,7})?)$

Destination coordinate represented by a "lat,lon" in the format "[-90,90],[-180,180]" allowing a numeric format with a maximum precision of 7 decimal digits.

time
string <date-time>

Reference time used to indicate desired arrival or departure.

timeContext
string
Enum:"ARR" "DEP"

Indicates, whether the time parameter is meant to be an arrival or departure time.

tsps
Array of string

A comma separated list of TSP ids restricting the result set. If this parameter is omitted, no restriction takes effect and therefore records for all eligible TSPs are returned. If this parameter is set, but is an empty list, no records will be returned. Unknown TSP ids will be ignored and do not result in an error.

sortTrips
string
Default: "DURATION_ASC"
Enum:"RANK_ASC" "RANK_DESC" "DURATION_ASC" "DURATION_DESC"

Determines the sort order of the result trips.

paymentType
string
Enum:"INVOICE" "PAY_ON_SITE"

Filter the result to contain only products payable with the specified payment type. Depending on the TSP, this may not be supported.

includeNavigationInstructions
boolean
Default: false

Indicates whether to include navigation instructions in the route calculations and in the output or not.

header Parameters
Accept-Language
string
x-excludeInSignature: true

The desired language for response content. RFC 2616

User-Reference
string
x-excludeInSignature: true

Optional, arbitrary reference to relate certain API calls to users. This may be used for reportings and the grouping of bookings (e.g. to query bookings by a user).

Responses

200

OK.

400

The provided input parameters are not valid.

401

Authentication is required, but no credentials were provided.

403

Authentication succeeded, but access to the requested resource was refused.

404

The requested resource is not available.

500

General error.

503

Service is temporarily unavailable.

get /{mspId}/route
https://ci-unstable-partnerhub.fluidtime.services/msp/{mspId}/route

Response samples

application/json
Copy
Expand all Collapse all
{
  • "trips":
    [