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.
Available custom Specification Extensions
(see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#specification-extensions):
x-emailValidation
Annotates the corresponding mutable/immutable springserver model
property with @Email
for validation (JSR380 Bean Validation 2.0).
x-excludeInSignature
Excludes the corresponding parameter in API stubs.
x-format
Custom format for data types. Supported formats are:
time
partial-time
(see: https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14). HH:mm[:ss[.SSS]]
is requiredx-phoneNumberValidation
Annotates the corresponding mutable/immutable springserver model
property with @PhoneNumber
for validation (JSR380 Bean Validation
2.0).
Used abbreviations:
A booking must be announced to make the actual booking call idempotent. Returns a nonce required for executing a booking.
Accept-Language | string The desired language for response content. RFC 2616 |
Request-UUID | string Request UUID. |
Nonce for the booking.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "nonce": "string"
}
Returns all bookings (for a specific user reference, if provided).
userId | string Filters bookings on external user reference as supplied with
|
includeStates | Array of strings (BookingState) Items Enum: "INITIATED" "PENDING" "OPEN" "COMPLETED" "FAILED" "ERROR" Comma separated list of booking states returned bookings can be in.
(Takes precedence over |
excludeStates | Array of strings (BookingState) Items Enum: "INITIATED" "PENDING" "OPEN" "COMPLETED" "FAILED" "ERROR" Comma separated list of booking state, returned bookings cannot be in. |
productTypes | Array of strings (ProductType) Items Enum: "ITEM" "PARKING" "RIDE" "TICKET" "VEHICLE" Product types to filter. |
tsps | Array of strings TSP ids of tsps to filter. |
startCreationDate | string <date> Filter for the creation date of a booking (inclusive). |
endCreationDate | string <date> Filter for the creation date of a booking (inclusive). |
page | integer <int32> >= 0 Default: 0 Number of the requested page. |
pSize | integer <int32> >= 1 Number of elements returned per page. |
tspBookingReference | string ^([*][^*]+|[^*]+[*]|[*][^*]+[*]|[^*]+)$ Tsp booking reference to filter. Wildcard (*) is supported at start and end of string |
fullTextSearch | string Searches string (startsWith-search) in booking full text index. Indexed fields are:
|
sort | Array of strings Default: "RELEVANCEDATE_DESC" Items Enum: "RELEVANCEDATE_ASC" "RELEVANCEDATE_DESC" "CREATEDATE_ASC" "CREATEDATE_DESC" "STATE_ASC" "STATE_DESC" "COMPLETIONREASON_ASC" "COMPLETIONREASON_DESC" "LASTSTATECHANGEDATE_ASC" "LASTSTATECHANGEDATE_DESC" Sorts the results by the provided parameters.
The default sorting of |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
List of bookings.
The provided input parameters are not valid.
The requested resource is not available.
The request was well-formed but was unable to be followed due to semantic errors.
General error.
Service is temporarily unavailable.
{- "bookings": [
- {
- "booking": {
- "billingInfo": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "company": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "bookedProduct": {
- "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "paymentType": "PAY_ON_SITE",
- "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productType": "ITEM",
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:44Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:44Z",
- "start": "2020-06-16T14:28:44Z"
}, - "pickTime": "2020-06-16T14:28:44Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:44Z",
- "start": "2020-06-16T14:28:44Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "rideStatus": "MATCHING",
- "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}, - "vehiclePosition": {
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "motion": {
- "heading": 0,
- "speed": 0
}
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:44Z",
- "redeemableTo": "2020-06-16T14:28:44Z",
- "validations": [
- {
- "confirmation": {
- "payload": "string",
- "type": "string"
}, - "validFrom": "2020-06-16T14:28:44Z",
- "validTo": "2020-06-16T14:28:44Z"
}
]
}, - "validationImage": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:44Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:44Z",
- "start": "2020-06-16T14:28:44Z"
}, - "returnTime": "2020-06-16T14:28:44Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:44Z",
- "start": "2020-06-16T14:28:44Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}, - "bookingReference": "string",
- "customer": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "drivingLicense": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "tspId": "string",
- "userReference": "string"
}, - "bookingId": "string",
- "completionReason": "COMPLETED",
- "cancelable": true,
- "createDate": "2020-06-16T14:28:44Z",
- "relevanceDate": "2020-06-16T14:28:44Z",
- "state": "INITIATED",
- "lastStateChangeDate": "2020-06-16T14:28:44Z",
- "updateDate": "2020-06-16T14:28:44Z"
}
], - "page": {
- "page": 0,
- "pageSize": 0,
- "totalSize": 0
}
}
Creates a booking using the previously acquired booking nonce.
The created booking will be in state INITIATED
but will not be
performed at the TSP until PUT /bookings/{identifier}/perform
is called.
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Object containing product references and booking information.
additionalBookingData | object (AdditionalBookingData) Additional data for a request object to book a product. |
nonce required | string non-empty The announce nonce that was created by /announce. |
product required | object (BookingRequestProduct) Reference to a bookable product, optionally with add-ons. |
Result of the booking.
The provided input parameters are not valid.
Authentication succeeded, but access to the requested resource was refused.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
General error.
Service is temporarily unavailable.
{- "additionalBookingData": {
- "billingInfo": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "company": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "corporateNumber": "string",
- "customer": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "drivingLicense": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "rateQualifierCode": "string"
}, - "nonce": "string",
- "product": {
- "productReference": "string"
}
}
{- "booking": {
- "billingInfo": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "company": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "bookedProduct": {
- "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "paymentType": "PAY_ON_SITE",
- "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productType": "ITEM",
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:45Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "pickTime": "2020-06-16T14:28:45Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "rideStatus": "MATCHING",
- "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}, - "vehiclePosition": {
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "motion": {
- "heading": 0,
- "speed": 0
}
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:45Z",
- "redeemableTo": "2020-06-16T14:28:45Z",
- "validations": [
- {
- "confirmation": {
- "payload": "string",
- "type": "string"
}, - "validFrom": "2020-06-16T14:28:45Z",
- "validTo": "2020-06-16T14:28:45Z"
}
]
}, - "validationImage": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:45Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "returnTime": "2020-06-16T14:28:45Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}, - "bookingReference": "string",
- "customer": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "drivingLicense": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "tspId": "string",
- "userReference": "string"
}, - "bookingId": "string",
- "completionReason": "COMPLETED",
- "cancelable": true,
- "createDate": "2020-06-16T14:28:45Z",
- "relevanceDate": "2020-06-16T14:28:45Z",
- "state": "INITIATED",
- "lastStateChangeDate": "2020-06-16T14:28:45Z",
- "updateDate": "2020-06-16T14:28:45Z",
- "hasBeenPerformed": true,
- "success": true
}
Anonymizes bookings to remove any relations to natural persons (hence GDPR is not applicable any more). The userId will be removed from those bookings.
userId required | string All bookings having this userId will be anonymized. |
Request-UUID | string Request UUID. |
OK
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
General error.
Service is temporarily unavailable.
{- "code": "string",
- "message": "string",
- "hints": [
- {
- "key": "string",
- "message": "string"
}
]
}
Returns the details of a specified booking.
identifier required | string non-empty Non-enumerable identifier. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Result of the booking.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "booking": {
- "billingInfo": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "company": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "bookedProduct": {
- "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "paymentType": "PAY_ON_SITE",
- "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productType": "ITEM",
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:45Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "pickTime": "2020-06-16T14:28:45Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "rideStatus": "MATCHING",
- "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}, - "vehiclePosition": {
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "motion": {
- "heading": 0,
- "speed": 0
}
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:45Z",
- "redeemableTo": "2020-06-16T14:28:45Z",
- "validations": [
- {
- "confirmation": {
- "payload": "string",
- "type": "string"
}, - "validFrom": "2020-06-16T14:28:45Z",
- "validTo": "2020-06-16T14:28:45Z"
}
]
}, - "validationImage": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:45Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "returnTime": "2020-06-16T14:28:45Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}, - "bookingReference": "string",
- "customer": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "drivingLicense": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "tspId": "string",
- "userReference": "string"
}, - "bookingId": "string",
- "completionReason": "COMPLETED",
- "cancelable": true,
- "createDate": "2020-06-16T14:28:45Z",
- "relevanceDate": "2020-06-16T14:28:45Z",
- "state": "INITIATED",
- "lastStateChangeDate": "2020-06-16T14:28:45Z",
- "updateDate": "2020-06-16T14:28:45Z"
}
Performs an INITIATED
booking at the TSP.
identifier required | string non-empty Non-enumerable identifier. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Result of the booking.
The provided input parameters are not valid.
Authentication succeeded, but access to the requested resource was refused.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
General error.
Service is temporarily unavailable.
{- "booking": {
- "billingInfo": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "company": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "bookedProduct": {
- "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "paymentType": "PAY_ON_SITE",
- "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productType": "ITEM",
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:45Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "pickTime": "2020-06-16T14:28:45Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "rideStatus": "MATCHING",
- "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}, - "vehiclePosition": {
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "motion": {
- "heading": 0,
- "speed": 0
}
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:45Z",
- "redeemableTo": "2020-06-16T14:28:45Z",
- "validations": [
- {
- "confirmation": {
- "payload": "string",
- "type": "string"
}, - "validFrom": "2020-06-16T14:28:45Z",
- "validTo": "2020-06-16T14:28:45Z"
}
]
}, - "validationImage": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:45Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "returnTime": "2020-06-16T14:28:45Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}, - "bookingReference": "string",
- "customer": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "drivingLicense": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "tspId": "string",
- "userReference": "string"
}, - "bookingId": "string",
- "completionReason": "COMPLETED",
- "cancelable": true,
- "createDate": "2020-06-16T14:28:45Z",
- "relevanceDate": "2020-06-16T14:28:45Z",
- "state": "INITIATED",
- "lastStateChangeDate": "2020-06-16T14:28:45Z",
- "updateDate": "2020-06-16T14:28:45Z",
- "hasBeenPerformed": true,
- "success": true
}
Cancels a specific booking via its id.
Concurrent cancellations for the same booking id result in a HTTP 409 Conflict for all executions but the first.
identifier required | string non-empty Non-enumerable identifier. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Result of the booking.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
General error.
Service is temporarily unavailable.
{- "booking": {
- "billingInfo": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "company": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "bookedProduct": {
- "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "paymentType": "PAY_ON_SITE",
- "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productType": "ITEM",
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:45Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "pickTime": "2020-06-16T14:28:45Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "rideStatus": "MATCHING",
- "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}, - "vehiclePosition": {
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "motion": {
- "heading": 0,
- "speed": 0
}
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:45Z",
- "redeemableTo": "2020-06-16T14:28:45Z",
- "validations": [
- {
- "confirmation": {
- "payload": "string",
- "type": "string"
}, - "validFrom": "2020-06-16T14:28:45Z",
- "validTo": "2020-06-16T14:28:45Z"
}
]
}, - "validationImage": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:45Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "returnTime": "2020-06-16T14:28:45Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}, - "bookingReference": "string",
- "customer": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "drivingLicense": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "tspId": "string",
- "userReference": "string"
}, - "bookingId": "string",
- "completionReason": "COMPLETED",
- "cancelable": true,
- "createDate": "2020-06-16T14:28:45Z",
- "relevanceDate": "2020-06-16T14:28:45Z",
- "state": "INITIATED",
- "lastStateChangeDate": "2020-06-16T14:28:45Z",
- "updateDate": "2020-06-16T14:28:45Z",
- "hasBeenPerformed": true,
- "success": true
}
The intended use for this operation is recovering bookings from
problematic states and is not to be used for regular workflows.
Furthermore, changes to a booking's state are not propagated to the
third-party web-service originally responsible for the booking.
(e.g. If set booking state is set to COMPLETED
with completion state
CANCELLED
, the booking is not cancelled at the TSP.)
Bookings can end up in state ERROR
, if the MSP API
delegating the
booking to a thrid-party web-service cannot determine whether the
booking has been successful or failed. This state requires manual
intervention, because the system cannot determine the booking state
within the third-party web-service due to missing the external booking
reference.
Bookings can end up in state PENDING
, if a rare internal error occurs
while the booking is processed by the MSP API. Basically this should
not happen and indicates a bug within the booking logic or a sudden
forceful end of the process. This state requires manual intervention,
because the booking is in an unknown state.
Normally, bookings are OPEN
until getting COMPLETED
by either
active cancellation by the MSC user or being automatically COMPLETED
via an automated sync with the third-party web-service when the
booking is being accessed. In some cases and with some third-party
services the information that a booking is COMPLETED
is not
available, leading to an indefinitely OPEN
booking. This case also
requires manual intervention to be resolved.
The following transitions are supported:
ERROR
-> OPEN
ERROR
-> COMPLETED
(any completion reason)ERROR
-> FAILED
PENDING
-> OPEN
PENDING
-> COMPLETED
(any completion reason)PENDING
-> FAILED
OPEN
-> COMPLETED
(any completion reason)OPEN
-> FAILED
If the targetState
is COMPLETED
, the completionReason
must be set,
otherwise it cannot be set.
identifier required | string non-empty Non-enumerable identifier. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Requested state change.
targetState required | string (BookingTargetState) Enum: "OPEN" "COMPLETED" "FAILED" Manual states to change a booking to. OPEN: Booking will be set in the state OPEN. Booking will be synchronized with an external provider again - this may lead to a non OPEN state. Properties of a booked product are subject to change. COMPLETED: The booked product is considered not to change any more. No further interactions with an external booking service regarding this booked product will be conducted. This is a final state. FAILED: The external booking service could not complete the booking. This is a final state. |
completionReason | string (BookingCompletionState) Enum: "COMPLETED" "CANCELLED" States of a completion reason. COMPLETED: The service related to the booked product has been successfully delivered. CANCELLED: The service related to the booked product has not been and will not be delivered in the future. |
Result of the booking.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
The request was well-formed but was unable to be followed due to semantic errors.
General error.
Service is temporarily unavailable.
{- "targetState": "OPEN",
- "completionReason": "COMPLETED"
}
{- "booking": {
- "billingInfo": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "company": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "bookedProduct": {
- "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "paymentType": "PAY_ON_SITE",
- "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productType": "ITEM",
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:45Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "pickTime": "2020-06-16T14:28:45Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "rideStatus": "MATCHING",
- "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}, - "vehiclePosition": {
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "motion": {
- "heading": 0,
- "speed": 0
}
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:45Z",
- "redeemableTo": "2020-06-16T14:28:45Z",
- "validations": [
- {
- "confirmation": {
- "payload": "string",
- "type": "string"
}, - "validFrom": "2020-06-16T14:28:45Z",
- "validTo": "2020-06-16T14:28:45Z"
}
]
}, - "validationImage": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:45Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "returnTime": "2020-06-16T14:28:45Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}, - "bookingReference": "string",
- "customer": {
- "address": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "country": "st",
- "postalCode": "string"
}, - "drivingLicense": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string"
}, - "tspId": "string",
- "userReference": "string"
}, - "bookingId": "string",
- "completionReason": "COMPLETED",
- "cancelable": true,
- "createDate": "2020-06-16T14:28:45Z",
- "relevanceDate": "2020-06-16T14:28:45Z",
- "state": "INITIATED",
- "lastStateChangeDate": "2020-06-16T14:28:45Z",
- "updateDate": "2020-06-16T14:28:45Z"
}
Returns all available MSP details.
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
MSP details.
The requested resource was not modified since the last request.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "description": "string",
- "languageCode": "st",
- "privacyPolicyUrl": "string",
- "supportEmail": "user@example.com",
- "supportHotline": "string",
- "supportUrl": "string",
- "termsOfServiceUrl": "string",
- "title": "string",
- "websiteUrl": "string",
- "icon": "string",
- "timezone": "string"
}
Returns the most suitable leg icon for the specified parameters. They can be considered as default icons. Apps may use their own icons.
modality | string non-empty General transit modality. See definition of |
transportation | string Mode of transport. See definition of |
serviceCategory | string Service category of a transit service. See definition of
|
serviceRange | string Scale of the operating area of a transit service. See definition of
|
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Returns the the most suitable leg icon in PNG format.
The requested resource was not modified since the last request.
The requested resource is not available.
General error.
Service is temporarily unavailable.
Returns all available TSPs for the specified MSP.
sort | string Default: "RELEVANCE_DESC" Enum: "RELEVANCE_ASC" "RELEVANCE_DESC" Determines the sort order of the resulting tsps. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
List of TSPs.
The requested resource was not modified since the last request.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
[- {
- "id": "string",
- "serviceProvider": true,
- "retired": true,
- "supportsBooking": true,
- "supportsLocations": true,
- "supportsRouting": true,
- "supportsSituations": true,
- "color": "string",
- "description": "string",
- "languageCode": "st",
- "privacyPolicyUrl": "string",
- "productSelectionWorkflow": "ITEM",
- "supportEmail": "user@example.com",
- "supportHotline": "string",
- "supportUrl": "string",
- "termsOfServiceUrl": "string",
- "title": "string",
- "applyLegStyling": true,
- "websiteUrl": "string",
- "icon": "string",
- "logo": "string",
- "operatingArea": {
- "type": "MultiPolygon",
- "coordinates": [
- [
- [
- [
- 0,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 0
]
]
]
]
}, - "locationGroups": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "interactable": true,
- "languageCode": "st",
- "maxIndicationZoomLevel": 0,
- "pin": "string",
- "pollingInterval": "string"
}
]
}
]
Returns details of a specific TSP available for a specific MSP.
identifier required | string non-empty Non-enumerable identifier. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
TSP details.
The requested resource was not modified since the last request.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "id": "string",
- "serviceProvider": true,
- "retired": true,
- "supportsBooking": true,
- "supportsLocations": true,
- "supportsRouting": true,
- "supportsSituations": true,
- "color": "string",
- "description": "string",
- "languageCode": "st",
- "privacyPolicyUrl": "string",
- "productSelectionWorkflow": "ITEM",
- "supportEmail": "user@example.com",
- "supportHotline": "string",
- "supportUrl": "string",
- "termsOfServiceUrl": "string",
- "title": "string",
- "applyLegStyling": true,
- "websiteUrl": "string",
- "icon": "string",
- "logo": "string",
- "operatingArea": {
- "type": "MultiPolygon",
- "coordinates": [
- [
- [
- [
- 0,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 0
]
]
]
]
}, - "locationGroups": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "interactable": true,
- "languageCode": "st",
- "maxIndicationZoomLevel": 0,
- "pin": "string",
- "pollingInterval": "string"
}
]
}
Returns the specified journey including the visited stops. A journey is used for departure monitors to provide the route of single vehicles together with the scheduled and estimated times of arrival and departure at preceding or subsequent stops.
identifier required | string non-empty A string which uniquely identifies a journey. The |
mode | string Enum: "PRE" "SUB" Specifies whether the preceding or subsequent stops, in relation to
the stop specified by |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
General error.
Service is temporarily unavailable.
{- "journeyPoints": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "isRequested": true,
- "locationId": "string",
- "stop": {
- "arrivalTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:45Z",
- "time": "2020-06-16T14:28:45Z"
}, - "departureTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:45Z",
- "time": "2020-06-16T14:28:45Z"
}, - "name": "string",
- "platform": "string",
- "reference": "string"
}
}
], - "situations": [
- {
- "airQualityDetails": {
- "condition": "VERY_GOOD",
- "description": "string",
- "level": 0,
- "pollutantLevelNO2": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "reference": 0,
- "summary": "string",
- "text": "string",
- "trafficDetails": {
- "trafficDelay": "string"
}, - "type": "AIR_QUALITY",
- "validityEnd": "2020-06-16T14:28:45Z",
- "validityStart": "2020-06-16T14:28:45Z",
- "weatherDetails": {
- "condition": "FAIR",
- "temperature": 0
}
}
], - "transitService": {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
}
This should be used for autocomplete searches instead of other
/locations*
endpoints.
Results are sorted by decreasing relevance in relation to the search
term specified by the name
parameter.
name required | string Filter locations by name. |
considerAddresses | boolean Default: false If set to true, addresses are also considered for the search. |
latLng | 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})?)$ 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. The coordinate is used as reference for regional biasing of search result. If not set, results do not consider any regional preferences. |
limit | integer <int32> [ 1 .. 1000 ] Maximum number of returned location candidates.
If not set, a default limit of |
searchSession | string <uuid> Defines a search session to optimise costs, if an external provider supports this. A search session begins with the user requesting location candidates as part of a location autocomplete search and ends with requesting location details via location id. The search session is generated by the server. Each session can have multiple location autocomplete requests followed by exactly one location details request. A session is considered complete thereafter. An ongoing search session will expire after some time depending on the external provider. |
locationGroups | Array of strings A comma separated list of TSP specific location group ids restricting the result set. If this parameter is omitted, no restriction takes effect and therefore records for all eligible location groups are returned. If this parameter is set, but is an empty list, no records will be returned. Unknown location group ids will be ignored and do not result in an error. |
productSelectionEligible | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location group is eligible for product selection. If this parameter is omitted, no filter is applied.
If |
time | string <date-time> Reference time used to determine the availability of locations with time based constraints. If set, only "open" locations will be returned for this point in time. |
tsps | Array of strings 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. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "candidates": [
- {
- "linearDistanceInMeters": 0,
- "locationGroupId": "string",
- "locationId": "string",
- "name": "string",
- "tspId": "string"
}
], - "searchSession": "string"
}
Converts a coordinate into a location.
latLng 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})?)$ Reference 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. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "location": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "cluster": {
- "locationGroups": [
- {
- "integer": 0,
- "key": "string"
}
], - "size": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "shortDescription": "string",
- "stop": {
- "transitServices": [
- {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
], - "transportations": [
- "WALK"
]
}, - "termsOfServiceUrl": "string",
- "travelDistance": {
- "distanceInMeters": 0,
- "travelDuration": "string"
}, - "tspId": "string",
- "vehicle": {
- "motion": {
- "heading": 0,
- "speed": 0
}
}
}
}
Returns locations witin a radius around a center coordinate.
The value of cLatLng
is considered the geographic center of the
location request for sorting returned locations.
If a zoomLevel
is provided and the parameter reductionMode
is set to
UNIFORM
, only an approximately uniformly distributed subset of
locations (adjustable via service configuration and per location group)
is returned.
If you are looking for locations in an autocomplete context or
addresses, GET /locationsAutocomplete
has to be used instead.
cLatLng 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})?)$ Center 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. |
radius required | integer <int32> [ 10 .. 100000 ] Radius of the search area around the center coordinate in meters. |
name | string non-empty Filter by |
iD | string Default: "NONE" Enum: "NONE" "WALK" "LD" Use |
idLatLng | 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})?)$ Reference 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.
If parameter |
sort | string Default: "AUTO" Enum: "AUTO" "CENTER" Returned locations are always sorted by the distance to a reference coordinate. The preferred coordinate to be used as the reference coordinate for determining the sort order can be specified by this parameter.
|
interactable | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location
group is defined as interactable. If this parameter is omitted, no filter
is applied.
If |
limit | integer <int32> >= 1 Maximum number of returned locations. |
locationGroups | Array of strings A comma separated list of TSP specific location group ids restricting the result set. If this parameter is omitted, no restriction takes effect and therefore records for all eligible location groups are returned. If this parameter is set, but is an empty list, no records will be returned. Unknown location group ids will be ignored and do not result in an error. |
time | string <date-time> Reference time used to determine the availability of locations with time based constraints. If set, only "open" locations will be returned for this point in time. |
tsps | Array of strings 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. |
productSelectionEligible | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location group is eligible for product selection. If this parameter is omitted, no filter is applied.
If |
reductionMode | string Default: "CLUSTER" Enum: "CLUSTER" "UNIFORM" This parameter only applies if a |
zoomLevel | integer [ 0 .. 20 ] Current zoom level of the web map used for clustering and deciding whether records are included in the result. If the zoom level parameter is not specified, no clustering or filtering will occur. Depending on the web map, zoom level may be in the range from 0 to 20. Please refer to http://wiki.openstreetmap.org/wiki/Zoom_levels and https://developers.google.com/maps/documentation/javascript/maxzoom |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "locations": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "cluster": {
- "locationGroups": [
- {
- "integer": 0,
- "key": "string"
}
], - "size": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "shortDescription": "string",
- "stop": {
- "transitServices": [
- {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
], - "transportations": [
- "WALK"
]
}, - "termsOfServiceUrl": "string",
- "travelDistance": {
- "distanceInMeters": 0,
- "travelDuration": "string"
}, - "tspId": "string",
- "vehicle": {
- "motion": {
- "heading": 0,
- "speed": 0
}
}
}
]
}
Returns locations within a bounding box specified by two coordinates.
The calculated center of the request's bounding box is considered the geographic center of the location request for sorting returned locations.
If a zoomLevel
is provided and the parameter reductionMode
is set to
UNIFORM
, only an approximately uniformly distributed subset of
locations (adjustable via service configuration and per location group)
is returned.
If you are looking for locations in an autocomplete context or
addresses, GET /locationsAutocomplete
has to be used instead.
neLatLng 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})?)$ North-east boundary 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. |
swLatLng 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})?)$ South-west boundary 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. |
name | string non-empty Filter by |
iD | string Default: "NONE" Enum: "NONE" "WALK" "LD" Use |
idLatLng | 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})?)$ Reference 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.
If parameter |
sort | string Default: "AUTO" Enum: "AUTO" "CENTER" Returned locations are always sorted by the distance to a reference coordinate. The preferred coordinate to be used as the reference coordinate for determining the sort order can be specified by this parameter.
|
interactable | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location
group is defined as interactable. If this parameter is omitted, no filter
is applied.
If |
limit | integer <int32> >= 1 Maximum number of returned locations. |
locationGroups | Array of strings A comma separated list of TSP specific location group ids restricting the result set. If this parameter is omitted, no restriction takes effect and therefore records for all eligible location groups are returned. If this parameter is set, but is an empty list, no records will be returned. Unknown location group ids will be ignored and do not result in an error. |
time | string <date-time> Reference time used to determine the availability of locations with time based constraints. If set, only "open" locations will be returned for this point in time. |
tsps | Array of strings 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. |
productSelectionEligible | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location group is eligible for product selection. If this parameter is omitted, no filter is applied.
If |
reductionMode | string Default: "CLUSTER" Enum: "CLUSTER" "UNIFORM" This parameter only applies if a |
zoomLevel | integer [ 0 .. 20 ] Current zoom level of the web map used for clustering and deciding whether records are included in the result. If the zoom level parameter is not specified, no clustering or filtering will occur. Depending on the web map, zoom level may be in the range from 0 to 20. Please refer to http://wiki.openstreetmap.org/wiki/Zoom_levels and https://developers.google.com/maps/documentation/javascript/maxzoom |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
The request was well-formed but was unable to be followed due to semantic errors.
General error.
Service is temporarily unavailable.
{- "locations": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "cluster": {
- "locationGroups": [
- {
- "integer": 0,
- "key": "string"
}
], - "size": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "shortDescription": "string",
- "stop": {
- "transitServices": [
- {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
], - "transportations": [
- "WALK"
]
}, - "termsOfServiceUrl": "string",
- "travelDistance": {
- "distanceInMeters": 0,
- "travelDuration": "string"
}, - "tspId": "string",
- "vehicle": {
- "motion": {
- "heading": 0,
- "speed": 0
}
}
}
]
}
Returns locations within a rectangle specified by four coordinates designating its corners. The coordinates have to be sorted by longitude from west to east. The order of 2 coordinates with the same longitude can be arbitrary. This definition of the coordinates' sequence is necessary to detect a rectangle which crosses the antimeridian.
The calculated center of the request's rectangle is considered the geographic center of the location request for sorting returned locations.
If a zoomLevel
is provided and the parameter reductionMode
is set to
UNIFORM
, only an approximately uniformly distributed subset of
locations (adjustable via service configuration and per location group)
is returned.
If you are looking for locations in an autocomplete context or
addresses, GET /locationsAutocomplete
has to be used instead.
latLng0 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})?)$ Most western corner coordinate of the rectangle. |
latLng1 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})?)$ Second most western corner coordinate of the rectangle. |
latLng2 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})?)$ Second most eastern corner coordinate of the rectangle. |
latLng3 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})?)$ Most eastern corner coordinate of the rectangle. |
name | string non-empty Filter by |
iD | string Default: "NONE" Enum: "NONE" "WALK" "LD" Use |
idLatLng | 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})?)$ Reference 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.
If parameter |
sort | string Default: "AUTO" Enum: "AUTO" "CENTER" Returned locations are always sorted by the distance to a reference coordinate. The preferred coordinate to be used as the reference coordinate for determining the sort order can be specified by this parameter.
|
interactable | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location
group is defined as interactable. If this parameter is omitted, no filter
is applied.
If |
limit | integer <int32> >= 1 Maximum number of returned locations. |
locationGroups | Array of strings A comma separated list of TSP specific location group ids restricting the result set. If this parameter is omitted, no restriction takes effect and therefore records for all eligible location groups are returned. If this parameter is set, but is an empty list, no records will be returned. Unknown location group ids will be ignored and do not result in an error. |
time | string <date-time> Reference time used to determine the availability of locations with time based constraints. If set, only "open" locations will be returned for this point in time. |
tsps | Array of strings 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. |
productSelectionEligible | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location group is eligible for product selection. If this parameter is omitted, no filter is applied.
If |
reductionMode | string Default: "CLUSTER" Enum: "CLUSTER" "UNIFORM" This parameter only applies if a |
zoomLevel | integer [ 0 .. 20 ] Current zoom level of the web map used for clustering and deciding whether records are included in the result. If the zoom level parameter is not specified, no clustering or filtering will occur. Depending on the web map, zoom level may be in the range from 0 to 20. Please refer to http://wiki.openstreetmap.org/wiki/Zoom_levels and https://developers.google.com/maps/documentation/javascript/maxzoom |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
The request was well-formed but was unable to be followed due to semantic errors.
General error.
Service is temporarily unavailable.
{- "locations": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "cluster": {
- "locationGroups": [
- {
- "integer": 0,
- "key": "string"
}
], - "size": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "shortDescription": "string",
- "stop": {
- "transitServices": [
- {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
], - "transportations": [
- "WALK"
]
}, - "termsOfServiceUrl": "string",
- "travelDistance": {
- "distanceInMeters": 0,
- "travelDuration": "string"
}, - "tspId": "string",
- "vehicle": {
- "motion": {
- "heading": 0,
- "speed": 0
}
}
}
]
}
Returns a specified number of locations near a given reference
coordinate cLatLng
.
The value of cLatLng
is considered the geographic center of the
location request for sorting returned locations.
If you are looking for locations in an autocomplete context or
addresses, GET /locationsAutocomplete
has to be used instead.
cLatLng 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})?)$ Center 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. |
limit | integer <int32> [ 1 .. 1000 ] Default: 10 Maximum number of returned locations. |
name | string non-empty Filter by |
iD | string Default: "NONE" Enum: "NONE" "WALK" "LD" Use |
idLatLng | 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})?)$ Reference 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.
If parameter |
sort | string Default: "AUTO" Enum: "AUTO" "CENTER" Returned locations are always sorted by the distance to a reference coordinate. The preferred coordinate to be used as the reference coordinate for determining the sort order can be specified by this parameter.
|
interactable | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location
group is defined as interactable. If this parameter is omitted, no filter
is applied.
If |
locationGroups | Array of strings A comma separated list of TSP specific location group ids restricting the result set. If this parameter is omitted, no restriction takes effect and therefore records for all eligible location groups are returned. If this parameter is set, but is an empty list, no records will be returned. Unknown location group ids will be ignored and do not result in an error. |
time | string <date-time> Reference time used to determine the availability of locations with time based constraints. If set, only "open" locations will be returned for this point in time. |
tsps | Array of strings 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. |
productSelectionEligible | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location group is eligible for product selection. If this parameter is omitted, no filter is applied.
If |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "locations": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "cluster": {
- "locationGroups": [
- {
- "integer": 0,
- "key": "string"
}
], - "size": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "shortDescription": "string",
- "stop": {
- "transitServices": [
- {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
], - "transportations": [
- "WALK"
]
}, - "termsOfServiceUrl": "string",
- "travelDistance": {
- "distanceInMeters": 0,
- "travelDuration": "string"
}, - "tspId": "string",
- "vehicle": {
- "motion": {
- "heading": 0,
- "speed": 0
}
}
}
]
}
Returns a specific number of locations by the specified parameters.
If parameter iD
(include distance) is specified, locations are sorted
by the distance to idLatLng
.
If you are looking for locations in an autocomplete context or
addresses, GET /locationsAutocomplete
has to be used instead.
Marked as deprecated. Use GET /locationsAutocomplete
instead.
name required | string non-empty Filter locations by |
iD | string Default: "NONE" Enum: "NONE" "WALK" "LD" Use |
idLatLng | 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})?)$ Reference 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.
If parameter |
interactable | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location
group is defined as interactable. If this parameter is omitted, no filter
is applied.
If |
locationGroups | Array of strings A comma separated list of TSP specific location group ids restricting the result set. If this parameter is omitted, no restriction takes effect and therefore records for all eligible location groups are returned. If this parameter is set, but is an empty list, no records will be returned. Unknown location group ids will be ignored and do not result in an error. |
time | string <date-time> Reference time used to determine the availability of locations with time based constraints. If set, only "open" locations will be returned for this point in time. |
tsps | Array of strings 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. |
productSelectionEligible | string Enum: "INCLUDE" "EXCLUDE" Filters the resulting locations on whether the corresponding location group is eligible for product selection. If this parameter is omitted, no filter is applied.
If |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "locations": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "cluster": {
- "locationGroups": [
- {
- "integer": 0,
- "key": "string"
}
], - "size": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "shortDescription": "string",
- "stop": {
- "transitServices": [
- {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
], - "transportations": [
- "WALK"
]
}, - "termsOfServiceUrl": "string",
- "travelDistance": {
- "distanceInMeters": 0,
- "travelDuration": "string"
}, - "tspId": "string",
- "vehicle": {
- "motion": {
- "heading": 0,
- "speed": 0
}
}
}
]
}
Returns the details of the location specified by the given identifier.
If departure monitor data is available to the location, it is contained
by the stop
attribute in the result.
A location may include bookable products including additional
information for that product. They are attached, if a product can be
booked based on a location (e.g. car sharing cars) and no route is
required (like for ride hailing products).
identifier required | string non-empty A string which uniquely identifies a location. |
searchSession | string <uuid> Defines a search session to optimise costs, if an external provider supports this. A search session begins with the user requesting location candidates as part of a location autocomplete search and ends with requesting location details via location id. The search session is generated by the server. Each session can have multiple location autocomplete requests followed by exactly one location details request. A session is considered complete thereafter. An ongoing search session will expire after some time depending on the external provider. |
ttWindow | string ^([-+]?)P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?$ Positive duration from now on establishing a time window within arrival and departure times of transit services should be included, if available for the specified location. |
ttMaxTimes | integer <int32> [ 1 .. 500 ] Default: 30 Maximum number of stop time entries per transit service timetable to be included, if available for the specified location. |
ttMode | string Default: "CHRONOLOGICAL" Enum: "CHRONOLOGICAL" "SERVICE" Determines the format in which departure and arrival times for a stop are returned. CHRONOLOGICAL:
Departure and arrival times are returned as a flat list in
chronological order in SERVICE:
Departure and arrival times are grouped by transit service and
returned in |
ttType | string Enum: "ALL" "ARR" "DEP" Filters stop time types of timetable entries. Either all time types, only arrival times or only departure times can be selected. |
ttTransportationTypes | Array of strings (Transportation) Items Enum: "WALK" "BIKE" "MOTORCYCLE" "CAR" "BUS" "COACH" "TROLLEY_BUS" "CABLE_CAR" "FUNICULAR" "ROPEWAY" "ELEVATOR" "ESCALATOR" "MOVING_WALKWAY" "TRAIN" "TRAM" "SUBWAY" "MONORAIL" "COG_RAIL" "BOAT" "FERRY" "PLANE" "SCOOTER" Transportation types to include. |
ttTransitServices | Array of strings Id of transit services to include. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
General error.
Service is temporarily unavailable.
{- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "businessHours": {
- "openingHours": [
- {
- "key": "MONDAY",
- "openingHours": {
- "closing": "string",
- "opening": "string"
}
}
], - "seasonEnd": {
- "day": 0,
- "month": 0
}, - "seasonStart": {
- "day": 0,
- "month": 0
}, - "zoneId": "string"
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "description": "string",
- "identifier": "string",
- "images": [
- {
- "content": "string"
}
], - "locationGroupId": "string",
- "locations": [
- { }
], - "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "paymentOptions": [
- "CASH"
], - "priceInfo": "string",
- "products": [
- {
- "bookingDeepLink": {
- "android": {
- "fallbackUrl": "string",
- "url": "string"
}, - "ios": {
- "fallbackUrl": "string",
- "url": "string"
}, - "webUrl": "string"
}, - "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "internalUUID": "string",
- "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productReference": "string",
- "productType": "ITEM",
- "reference": 0,
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:45Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "pickTime": "2020-06-16T14:28:45Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:45Z",
- "redeemableTo": "2020-06-16T14:28:45Z"
}, - "tspId": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:45Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "returnTime": "2020-06-16T14:28:45Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:45Z",
- "start": "2020-06-16T14:28:45Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}
], - "shortDescription": "string",
- "situations": [
- {
- "airQualityDetails": {
- "condition": "VERY_GOOD",
- "description": "string",
- "level": 0,
- "pollutantLevelNO2": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "reference": 0,
- "summary": "string",
- "text": "string",
- "trafficDetails": {
- "trafficDelay": "string"
}, - "type": "AIR_QUALITY",
- "validityEnd": "2020-06-16T14:28:45Z",
- "validityStart": "2020-06-16T14:28:45Z",
- "weatherDetails": {
- "condition": "FAIR",
- "temperature": 0
}
}
], - "stop": {
- "platform": "string",
- "schedule": [
- {
- "timetableEntries": [
- {
- "arrivalTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:45Z",
- "time": "2020-06-16T14:28:45Z"
}, - "departureTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:45Z",
- "time": "2020-06-16T14:28:45Z"
}, - "journeyPointId": "string",
- "platform": "string",
- "serviceDestination": "string",
- "serviceDirection": "FORWARDS",
- "serviceOrigin": "string",
- "wheelchairAccessible": true
}
], - "transitService": {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
}
], - "timetable": [
- {
- "arrivalTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:45Z",
- "time": "2020-06-16T14:28:45Z"
}, - "departureTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:45Z",
- "time": "2020-06-16T14:28:45Z"
}, - "journeyPointId": "string",
- "platform": "string",
- "serviceDestination": "string",
- "serviceDirection": "FORWARDS",
- "serviceOrigin": "string",
- "transitService": {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}, - "wheelchairAccessible": true
}
], - "transitServices": [
- {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
], - "transportations": [
- "WALK"
]
}, - "termsOfServiceUrl": "string",
- "tspId": "string",
- "vehicle": {
- "journeyPointId": "string",
- "motion": {
- "heading": 0,
- "speed": 0
}, - "reference": "string",
- "transitService": {
- "identifier": "string",
- "name": "string",
- "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}, - "transportation": "WALK"
}
}
}
Returns all ride products (offers) matching the provided 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 |
tsps | Array of strings 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. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Ride products.
The provided input parameters are not valid.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
General error.
Service is temporarily unavailable.
{- "productList": [
- {
- "bookingDeepLink": {
- "android": {
- "fallbackUrl": "string",
- "url": "string"
}, - "ios": {
- "fallbackUrl": "string",
- "url": "string"
}, - "webUrl": "string"
}, - "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "internalUUID": "string",
- "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productReference": "string",
- "productType": "ITEM",
- "reference": 0,
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:46Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "pickTime": "2020-06-16T14:28:46Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:46Z",
- "redeemableTo": "2020-06-16T14:28:46Z"
}, - "tspId": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:46Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "returnTime": "2020-06-16T14:28:46Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}
]
}
Returns all vehicle products (offers) matching the provided parameters.
tspId required | string ^[a-zA-Z0-9_-]{1,16}$ Non enumerable TSP id restricting the result set. |
pickupTime | string <date-time> Time to pickup a vehicle. If not set, Time has to be within a preconfigured tolerance before The pickup time has to be before the return time. If the pickup time is before the return time an error is raised. |
returnTime | string <date-time> Time to return a vehicle. Depending on the TSP, this has to be set or not. The return time has to be after the pickup time. If the return time is before the pickup time an error is raised. |
pickupLocationId required | string Pickup location identifier. Can be retrieved via location calls. |
returnLocationId | string Return location identifier. Can be retrieved via location calls. Depending on the TSP, this has to be set or not. If not set,
the same value as in |
acrissCodes | Array of strings Comma separated list of acriss codes to filter. |
corporateNumber | string Corporation number. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Vehicle products.
The provided input parameters are not valid.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
The request was well-formed but was unable to be followed due to semantic errors.
General error.
Service is temporarily unavailable.
{- "productList": [
- {
- "bookingDeepLink": {
- "android": {
- "fallbackUrl": "string",
- "url": "string"
}, - "ios": {
- "fallbackUrl": "string",
- "url": "string"
}, - "webUrl": "string"
}, - "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "internalUUID": "string",
- "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productReference": "string",
- "productType": "ITEM",
- "reference": 0,
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:46Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "pickTime": "2020-06-16T14:28:46Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:46Z",
- "redeemableTo": "2020-06-16T14:28:46Z"
}, - "tspId": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:46Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "returnTime": "2020-06-16T14:28:46Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}
]
}
Returns all bookable ticket products available from the specified TSP.
tspId required | string ^[a-zA-Z0-9_-]{1,16}$ Non enumerable TSP id restricting the result set. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
Ticket products.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
General error.
Service is temporarily unavailable.
{- "productList": [
- {
- "bookingDeepLink": {
- "android": {
- "fallbackUrl": "string",
- "url": "string"
}, - "ios": {
- "fallbackUrl": "string",
- "url": "string"
}, - "webUrl": "string"
}, - "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "internalUUID": "string",
- "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productReference": "string",
- "productType": "ITEM",
- "reference": 0,
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:46Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "pickTime": "2020-06-16T14:28:46Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:46Z",
- "redeemableTo": "2020-06-16T14:28:46Z"
}, - "tspId": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:46Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "returnTime": "2020-06-16T14:28:46Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}
]
}
Returns a report for bookings within the specified interval.
aggregationInterval | string Enum: "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" The preferred time unit a time series should use for aggregation. If not provided, a meaningful default is set. |
startDate | string <date-time> Defines the start of the interval, the request considers. If not set, a meaningful default applies. |
endDate | string <date-time> Defines the end of the interval, the request considers. If not set, all entries to now will be considered. |
tsps | Array of strings 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. |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
The request was well-formed but was unable to be followed due to semantic errors.
General error.
{- "timeSeries": [
- {
- "name": "string",
- "data": [
- {
- "time": "2020-06-16T14:28:46Z",
- "value": 0
}
]
}
], - "aggregationInterval": "MINUTE"
}
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.
Clients must either set a location id or a coordinate parameter for origin and destination. It is not allowed to set both parameters for origin or destination.
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.
oLatLng | 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 | 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. |
oLocationId | string non-empty Origin location id which uniquely identifies a location. |
dLocationId | string non-empty Destination location id which uniquely identifies a location. |
time | string <date-time> Reference time used to indicate desired arrival or departure. |
timeContext | string Enum: "ARR" "DEP" Indicates, whether the |
transportationTypes | Array of strings (Transportation) Items Enum: "WALK" "BIKE" "MOTORCYCLE" "CAR" "BUS" "COACH" "TROLLEY_BUS" "CABLE_CAR" "FUNICULAR" "ROPEWAY" "ELEVATOR" "ESCALATOR" "MOVING_WALKWAY" "TRAIN" "TRAM" "SUBWAY" "MONORAIL" "COG_RAIL" "BOAT" "FERRY" "PLANE" "SCOOTER" Transportation types to include. If no routes can be found with the provided parameter, routes with alternative transportation types may be included. |
tsps | Array of strings 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. |
sort | Array of strings Default: "DURATION_ASC" Items Enum: "ARRIVAL_TIME_ASC" "ARRIVAL_TIME_DESC" "RELEVANCE_ASC" "RELEVANCE_DESC" "DEPARTURE_TIME_ASC" "DEPARTURE_TIME_DESC" "DURATION_ASC" "DURATION_DESC" "WALKING_TIME_ASC" "WALKING_TIME_DESC" "CHANGE_COUNT_ASC" "CHANGE_COUNT_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. |
viaLocationIds | Array of strings One or more (comma-separated) location ids that are used as via locations, i.e. locations to include along the route between the origin and destination. This parameter is not supported by all routers. Therefore not all returned trips may reflect this parameter. |
includeNavigationInstructions | boolean Default: false Indicates whether to include navigation instructions in the route calculations and in the output or not. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
The provided data is conflicting or would result in a conflict if applied.
The request was well-formed but was unable to be followed due to semantic errors.
General error.
Service is temporarily unavailable.
{- "trips": [
- {
- "boundingBox": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "contentLocale": "string",
- "copyrights": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "arrival": {
- "stop": {
- "name": "string",
- "platform": "string",
- "stopTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}
}, - "time": "2020-06-16T14:28:46Z",
- "timeWindowStart": "2020-06-16T14:28:46Z"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "businessHours": {
- "openingHours": [
- {
- "key": "MONDAY",
- "openingHours": {
- "closing": "string",
- "opening": "string"
}
}
], - "seasonEnd": {
- "day": 0,
- "month": 0
}, - "seasonStart": {
- "day": 0,
- "month": 0
}, - "zoneId": "string"
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "description": "string",
- "identifier": "string",
- "leg": {
- "boundingBox": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "description": "string",
- "distanceInMeters": 0,
- "identifier": "string",
- "isDistanceApproximated": true,
- "maxDurationInTraffic": "string",
- "minDurationInTraffic": "string",
- "modality": "PRIVATE_TRANSIT",
- "navigationInstructions": [
- {
- "absoluteDirection": "NORTH",
- "contentLocale": "string",
- "distance": 0,
- "instruction": "string",
- "polyline": "string",
- "position": {
- "latitude": -90,
- "longitude": -180
}, - "streetName": "string",
- "travelDuration": "string",
- "type": "UNKNOWN"
}
], - "polyline": "string",
- "productReferences": [
- 0
], - "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "situationReferences": [
- 0
], - "stopSequence": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "isRequested": true,
- "locationId": "string",
- "stop": {
- "arrivalTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}, - "departureTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}, - "name": "string",
- "platform": "string",
- "reference": "string"
}
}
], - "trafficDelay": "string",
- "transitService": {
- "identifier": "string",
- "name": "string",
- "serviceDestination": "string",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}
}, - "transportation": "WALK",
- "travelDuration": "string",
- "tspId": "string",
- "wheelchairAccessible": true
}, - "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "situationReferences": [
- 0
], - "termsOfServiceUrl": "string",
- "tspId": "string"
}, - "distanceInMeters": 0,
- "identifier": "string",
- "isDistanceApproximated": true,
- "maxDurationInTraffic": "string",
- "minDurationInTraffic": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "businessHours": {
- "openingHours": [
- {
- "key": "MONDAY",
- "openingHours": {
- "closing": "string",
- "opening": "string"
}
}
], - "seasonEnd": {
- "day": 0,
- "month": 0
}, - "seasonStart": {
- "day": 0,
- "month": 0
}, - "zoneId": "string"
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "departure": {
- "stop": {
- "name": "string",
- "platform": "string",
- "stopTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}
}, - "time": "2020-06-16T14:28:46Z",
- "timeWindowEnd": "2020-06-16T14:28:46Z"
}, - "description": "string",
- "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "situationReferences": [
- 0
], - "termsOfServiceUrl": "string",
- "tspId": "string"
}, - "polyline": "string",
- "products": [
- {
- "bookingDeepLink": {
- "android": {
- "fallbackUrl": "string",
- "url": "string"
}, - "ios": {
- "fallbackUrl": "string",
- "url": "string"
}, - "webUrl": "string"
}, - "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "internalUUID": "string",
- "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productReference": "string",
- "productType": "ITEM",
- "reference": 0,
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:46Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "pickTime": "2020-06-16T14:28:46Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:46Z",
- "redeemableTo": "2020-06-16T14:28:46Z"
}, - "tspId": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:46Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "returnTime": "2020-06-16T14:28:46Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}
], - "situations": [
- {
- "airQualityDetails": {
- "condition": "VERY_GOOD",
- "description": "string",
- "level": 0,
- "pollutantLevelNO2": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "reference": 0,
- "summary": "string",
- "text": "string",
- "trafficDetails": {
- "trafficDelay": "string"
}, - "type": "AIR_QUALITY",
- "validityEnd": "2020-06-16T14:28:46Z",
- "validityStart": "2020-06-16T14:28:46Z",
- "weatherDetails": {
- "condition": "FAIR",
- "temperature": 0
}
}
], - "tentative": true,
- "travelDuration": "string",
- "tspId": "string",
- "warnings": [
- "string"
], - "waypoints": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "arrival": {
- "stop": {
- "name": "string",
- "platform": "string",
- "stopTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}
}, - "time": "2020-06-16T14:28:46Z",
- "timeWindowStart": "2020-06-16T14:28:46Z"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "businessHours": {
- "openingHours": [
- {
- "key": "MONDAY",
- "openingHours": {
- "closing": "string",
- "opening": "string"
}
}
], - "seasonEnd": {
- "day": 0,
- "month": 0
}, - "seasonStart": {
- "day": 0,
- "month": 0
}, - "zoneId": "string"
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "departure": {
- "stop": {
- "name": "string",
- "platform": "string",
- "stopTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}
}, - "time": "2020-06-16T14:28:46Z",
- "timeWindowEnd": "2020-06-16T14:28:46Z"
}, - "description": "string",
- "identifier": "string",
- "leg": {
- "boundingBox": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "description": "string",
- "distanceInMeters": 0,
- "identifier": "string",
- "isDistanceApproximated": true,
- "maxDurationInTraffic": "string",
- "minDurationInTraffic": "string",
- "modality": "PRIVATE_TRANSIT",
- "navigationInstructions": [
- {
- "absoluteDirection": "NORTH",
- "contentLocale": "string",
- "distance": 0,
- "instruction": "string",
- "polyline": "string",
- "position": {
- "latitude": -90,
- "longitude": -180
}, - "streetName": "string",
- "travelDuration": "string",
- "type": "UNKNOWN"
}
], - "polyline": "string",
- "productReferences": [
- 0
], - "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "situationReferences": [
- 0
], - "stopSequence": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "isRequested": true,
- "locationId": "string",
- "stop": {
- "arrivalTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}, - "departureTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}, - "name": "string",
- "platform": "string",
- "reference": "string"
}
}
], - "trafficDelay": "string",
- "transitService": {
- "identifier": "string",
- "name": "string",
- "serviceDestination": "string",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}
}, - "transportation": "WALK",
- "travelDuration": "string",
- "tspId": "string",
- "wheelchairAccessible": true
}, - "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "situationReferences": [
- 0
], - "termsOfServiceUrl": "string",
- "tspId": "string",
- "wait": "string"
}
]
}
]
}
Returns a suggestion for a possible walking trip to accomplish the requested route request. This will return either 0 or 1 trip.
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. |
includeNavigationInstructions | boolean Default: false Indicates whether to include navigation instructions in the route calculations and in the output or not. |
Accept-Language | string The desired language for response content. RFC 2616 |
User-Reference | string 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). |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "trip": {
- "boundingBox": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "contentLocale": "string",
- "copyrights": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "arrival": {
- "stop": {
- "name": "string",
- "platform": "string",
- "stopTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}
}, - "time": "2020-06-16T14:28:46Z",
- "timeWindowStart": "2020-06-16T14:28:46Z"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "businessHours": {
- "openingHours": [
- {
- "key": "MONDAY",
- "openingHours": {
- "closing": "string",
- "opening": "string"
}
}
], - "seasonEnd": {
- "day": 0,
- "month": 0
}, - "seasonStart": {
- "day": 0,
- "month": 0
}, - "zoneId": "string"
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "description": "string",
- "identifier": "string",
- "leg": {
- "boundingBox": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "description": "string",
- "distanceInMeters": 0,
- "identifier": "string",
- "isDistanceApproximated": true,
- "maxDurationInTraffic": "string",
- "minDurationInTraffic": "string",
- "modality": "PRIVATE_TRANSIT",
- "navigationInstructions": [
- {
- "absoluteDirection": "NORTH",
- "contentLocale": "string",
- "distance": 0,
- "instruction": "string",
- "polyline": "string",
- "position": {
- "latitude": -90,
- "longitude": -180
}, - "streetName": "string",
- "travelDuration": "string",
- "type": "UNKNOWN"
}
], - "polyline": "string",
- "productReferences": [
- 0
], - "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "situationReferences": [
- 0
], - "stopSequence": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "isRequested": true,
- "locationId": "string",
- "stop": {
- "arrivalTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}, - "departureTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}, - "name": "string",
- "platform": "string",
- "reference": "string"
}
}
], - "trafficDelay": "string",
- "transitService": {
- "identifier": "string",
- "name": "string",
- "serviceDestination": "string",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}
}, - "transportation": "WALK",
- "travelDuration": "string",
- "tspId": "string",
- "wheelchairAccessible": true
}, - "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "situationReferences": [
- 0
], - "termsOfServiceUrl": "string",
- "tspId": "string"
}, - "distanceInMeters": 0,
- "identifier": "string",
- "isDistanceApproximated": true,
- "maxDurationInTraffic": "string",
- "minDurationInTraffic": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "businessHours": {
- "openingHours": [
- {
- "key": "MONDAY",
- "openingHours": {
- "closing": "string",
- "opening": "string"
}
}
], - "seasonEnd": {
- "day": 0,
- "month": 0
}, - "seasonStart": {
- "day": 0,
- "month": 0
}, - "zoneId": "string"
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "departure": {
- "stop": {
- "name": "string",
- "platform": "string",
- "stopTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}
}, - "time": "2020-06-16T14:28:46Z",
- "timeWindowEnd": "2020-06-16T14:28:46Z"
}, - "description": "string",
- "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "situationReferences": [
- 0
], - "termsOfServiceUrl": "string",
- "tspId": "string"
}, - "polyline": "string",
- "products": [
- {
- "bookingDeepLink": {
- "android": {
- "fallbackUrl": "string",
- "url": "string"
}, - "ios": {
- "fallbackUrl": "string",
- "url": "string"
}, - "webUrl": "string"
}, - "contentLocale": "string",
- "description": "string",
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "internalUUID": "string",
- "itemDetails": {
- "images": [
- {
- "content": "string"
}
]
}, - "name": "string",
- "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}, - "productCode": "string",
- "productReference": "string",
- "productType": "ITEM",
- "reference": 0,
- "rideDetails": {
- "brandName": "string",
- "driver": {
- "age": 0,
- "gender": "FEMALE",
- "image": "string",
- "imageUrl": "string",
- "name": "string",
- "occupation": "string",
- "phoneNumber": "string",
- "rating": 0,
- "ratingCount": 0
}, - "driversRide": {
- "destination": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "origin": {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "identifier": "string",
- "locationGroupId": "string",
- "name": "string",
- "tspId": "string"
}, - "price": {
- "amount": 0,
- "currency": "str",
- "isEstimated": true,
- "vatIncludedPercentage": 0
}
}, - "dropTime": "2020-06-16T14:28:46Z",
- "dropWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "pickTime": "2020-06-16T14:28:46Z",
- "pickWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "ride": {
- "baggageAllowance": "SMALL",
- "comfort": true,
- "seatsLeft": 0,
- "seatsOffered": 0,
- "smoking": true
}, - "travelClass": "STANDARD",
- "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}, - "termsOfServiceUrl": "string",
- "ticketDetails": {
- "redeemableFrom": "2020-06-16T14:28:46Z",
- "redeemableTo": "2020-06-16T14:28:46Z"
}, - "tspId": "string",
- "vehicleDetails": {
- "acrissCode": "stri",
- "pickupTime": "2020-06-16T14:28:46Z",
- "pickupWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "returnTime": "2020-06-16T14:28:46Z",
- "returnWindow": {
- "end": "2020-06-16T14:28:46Z",
- "start": "2020-06-16T14:28:46Z"
}, - "vehicle": {
- "airCondition": true,
- "baggageCapacity": 0,
- "buildYear": 0,
- "colorDescription": "string",
- "engineType": "COMBUSTION_ENGINE",
- "exteriorState": "GOOD",
- "fuelType": "DIESEL",
- "image": "string",
- "imageUrl": "string",
- "interiorState": "GOOD",
- "licensePlate": "string",
- "make": "string",
- "model": "string",
- "passengerCapacity": 0,
- "transmissionType": "AUTOMATIC"
}
}
}
], - "situations": [
- {
- "airQualityDetails": {
- "condition": "VERY_GOOD",
- "description": "string",
- "level": 0,
- "pollutantLevelNO2": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "reference": 0,
- "summary": "string",
- "text": "string",
- "trafficDetails": {
- "trafficDelay": "string"
}, - "type": "AIR_QUALITY",
- "validityEnd": "2020-06-16T14:28:46Z",
- "validityStart": "2020-06-16T14:28:46Z",
- "weatherDetails": {
- "condition": "FAIR",
- "temperature": 0
}
}
], - "tentative": true,
- "travelDuration": "string",
- "tspId": "string",
- "warnings": [
- "string"
], - "waypoints": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "arrival": {
- "stop": {
- "name": "string",
- "platform": "string",
- "stopTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}
}, - "time": "2020-06-16T14:28:46Z",
- "timeWindowStart": "2020-06-16T14:28:46Z"
}, - "bikesharingStation": {
- "availableBikes": 0,
- "availableRacks": 0,
- "totalRacks": 0
}, - "businessHours": {
- "openingHours": [
- {
- "key": "MONDAY",
- "openingHours": {
- "closing": "string",
- "opening": "string"
}
}
], - "seasonEnd": {
- "day": 0,
- "month": 0
}, - "seasonStart": {
- "day": 0,
- "month": 0
}, - "zoneId": "string"
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "departure": {
- "stop": {
- "name": "string",
- "platform": "string",
- "stopTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}
}, - "time": "2020-06-16T14:28:46Z",
- "timeWindowEnd": "2020-06-16T14:28:46Z"
}, - "description": "string",
- "identifier": "string",
- "leg": {
- "boundingBox": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "description": "string",
- "distanceInMeters": 0,
- "identifier": "string",
- "isDistanceApproximated": true,
- "maxDurationInTraffic": "string",
- "minDurationInTraffic": "string",
- "modality": "PRIVATE_TRANSIT",
- "navigationInstructions": [
- {
- "absoluteDirection": "NORTH",
- "contentLocale": "string",
- "distance": 0,
- "instruction": "string",
- "polyline": "string",
- "position": {
- "latitude": -90,
- "longitude": -180
}, - "streetName": "string",
- "travelDuration": "string",
- "type": "UNKNOWN"
}
], - "polyline": "string",
- "productReferences": [
- 0
], - "serviceCategory": "OPERATED",
- "serviceRange": "LOCAL",
- "situationReferences": [
- 0
], - "stopSequence": [
- {
- "address": {
- "addition": "string",
- "city": "string",
- "country": "st",
- "district": "string",
- "identifier": "string",
- "name": "string",
- "postalCode": "string",
- "street": "string"
}, - "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "isRequested": true,
- "locationId": "string",
- "stop": {
- "arrivalTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}, - "departureTime": {
- "discrepancy": "string",
- "estimatedTime": "2020-06-16T14:28:46Z",
- "time": "2020-06-16T14:28:46Z"
}, - "name": "string",
- "platform": "string",
- "reference": "string"
}
}
], - "trafficDelay": "string",
- "transitService": {
- "identifier": "string",
- "name": "string",
- "serviceDestination": "string",
- "signageColor": "string",
- "signageTextColor": "string",
- "transitAgency": {
- "description": "string",
- "identifier": "string",
- "name": "string",
- "uri": "string"
}
}, - "transportation": "WALK",
- "travelDuration": "string",
- "tspId": "string",
- "wheelchairAccessible": true
}, - "locationGroupId": "string",
- "name": "string",
- "parking": {
- "area": {
- "northEast": {
- "latitude": -90,
- "longitude": -180
}, - "southWest": {
- "latitude": -90,
- "longitude": -180
}
}, - "availabilityProbability": "LOW",
- "availableSpaces": 0,
- "capacity": 0,
- "features": [
- "DISABLED_PARKING_SPACES"
], - "lane": "string",
- "maxHeight": 1,
- "maxLength": 1,
- "maxWeight": 1,
- "maxWidth": 1,
- "type": "ON_STREET"
}, - "situationReferences": [
- 0
], - "termsOfServiceUrl": "string",
- "tspId": "string",
- "wait": "string"
}
]
}
}
Get situations based on different criteria.
tsps | Array of strings 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. |
situationTypes | Array of strings (SituationType) Items Enum: "AIR_QUALITY" "WEATHER" "TRAFFIC" "MESSAGE" "TOLLING" Only include given situation types. |
Accept-Language | string The desired language for response content. RFC 2616 |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "situations": [
- {
- "airQualityDetails": {
- "condition": "VERY_GOOD",
- "description": "string",
- "level": 0,
- "pollutantLevelNO2": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "reference": 0,
- "summary": "string",
- "text": "string",
- "trafficDetails": {
- "trafficDelay": "string"
}, - "type": "AIR_QUALITY",
- "validityEnd": "2020-06-16T14:28:46Z",
- "validityStart": "2020-06-16T14:28:46Z",
- "weatherDetails": {
- "condition": "FAIR",
- "temperature": 0
}
}
]
}
Returns situations within a bounding box specified by two coordinates. Returned situations are sorted by the distance to the calculated center of the request's bounding box. Situations without coordinates will not be returned.
neLatLng 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})?)$ North-east boundary 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. |
swLatLng 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})?)$ South-west boundary 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. |
tsps | Array of strings 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. |
zoomLevel | integer [ 0 .. 20 ] Current zoom level of the web map used for clustering and deciding whether records are included in the result. If the zoom level parameter is not specified, no clustering or filtering will occur. Depending on the web map, zoom level may be in the range from 0 to 20. Please refer to http://wiki.openstreetmap.org/wiki/Zoom_levels and https://developers.google.com/maps/documentation/javascript/maxzoom |
situationTypes | Array of strings (SituationType) Items Enum: "AIR_QUALITY" "WEATHER" "TRAFFIC" "MESSAGE" "TOLLING" Only include given situation types. |
Accept-Language | string The desired language for response content. RFC 2616 |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "situations": [
- {
- "airQualityDetails": {
- "condition": "VERY_GOOD",
- "description": "string",
- "level": 0,
- "pollutantLevelNO2": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "reference": 0,
- "summary": "string",
- "text": "string",
- "trafficDetails": {
- "trafficDelay": "string"
}, - "type": "AIR_QUALITY",
- "validityEnd": "2020-06-16T14:28:46Z",
- "validityStart": "2020-06-16T14:28:46Z",
- "weatherDetails": {
- "condition": "FAIR",
- "temperature": 0
}
}
]
}
Returns situations within a rectangle specified by four coordinates designating its corners. The coordinates have to be sorted by longitude from west to east. The order of 2 coordinates with the same longitude can be arbitrary. This definition of the coordinates' sequence is necessary to detect a rectangle which crosses the antimeridian. Returned locations are sorted by the distance to the calculated center of the request's rectangle. Situations without coordinates will not be returned.
latLng0 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})?)$ Most western corner coordinate of the rectangle. |
latLng1 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})?)$ Second most western corner coordinate of the rectangle. |
latLng2 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})?)$ Second most eastern corner coordinate of the rectangle. |
latLng3 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})?)$ Most eastern corner coordinate of the rectangle. |
tsps | Array of strings 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. |
zoomLevel | integer [ 0 .. 20 ] Current zoom level of the web map used for clustering and deciding whether records are included in the result. If the zoom level parameter is not specified, no clustering or filtering will occur. Depending on the web map, zoom level may be in the range from 0 to 20. Please refer to http://wiki.openstreetmap.org/wiki/Zoom_levels and https://developers.google.com/maps/documentation/javascript/maxzoom |
situationTypes | Array of strings (SituationType) Items Enum: "AIR_QUALITY" "WEATHER" "TRAFFIC" "MESSAGE" "TOLLING" Only include given situation types. |
Accept-Language | string The desired language for response content. RFC 2616 |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "situations": [
- {
- "airQualityDetails": {
- "condition": "VERY_GOOD",
- "description": "string",
- "level": 0,
- "pollutantLevelNO2": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "reference": 0,
- "summary": "string",
- "text": "string",
- "trafficDetails": {
- "trafficDelay": "string"
}, - "type": "AIR_QUALITY",
- "validityEnd": "2020-06-16T14:28:46Z",
- "validityStart": "2020-06-16T14:28:46Z",
- "weatherDetails": {
- "condition": "FAIR",
- "temperature": 0
}
}
]
}
Returns a specified number of situations near a given reference coordinate. Returned situations are sorted by the distance to the given reference coordinate. Situations without coordinates will not be returned.
cLatLng 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})?)$ Center 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. |
limit | integer <int32> [ 1 .. 1000 ] Default: 10 Maximum number of returned situations. |
tsps | Array of strings 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. |
situationTypes | Array of strings (SituationType) Items Enum: "AIR_QUALITY" "WEATHER" "TRAFFIC" "MESSAGE" "TOLLING" Only include given situation types. |
Accept-Language | string The desired language for response content. RFC 2616 |
Request-UUID | string Request UUID. |
OK.
The provided input parameters are not valid.
The requested resource is not available.
General error.
Service is temporarily unavailable.
{- "situations": [
- {
- "airQualityDetails": {
- "condition": "VERY_GOOD",
- "description": "string",
- "level": 0,
- "pollutantLevelNO2": 0
}, - "contentLocale": "string",
- "coordinate": {
- "latitude": -90,
- "longitude": -180
}, - "reference": 0,
- "summary": "string",
- "text": "string",
- "trafficDetails": {
- "trafficDelay": "string"
}, - "type": "AIR_QUALITY",
- "validityEnd": "2020-06-16T14:28:46Z",
- "validityStart": "2020-06-16T14:28:46Z",
- "weatherDetails": {
- "condition": "FAIR",
- "temperature": 0
}
}
]
}