Skip to content

Instantly share code, notes, and snippets.

@amixpal

amixpal/gist:dcb647d07c5de55b7399c2483fc66b5c

Created January 14, 2023 17:20
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save amixpal/dcb647d07c5de55b7399c2483fc66b5c to your computer and use it in GitHub Desktop.
Save amixpal/dcb647d07c5de55b7399c2483fc66b5c to your computer and use it in GitHub Desktop.
Download ZIP
spotlight.yaml
Raw
gistfile1.txt
openapi: 3.1.0
info:
title: Automicle API Reference
version: '1.0'
description: |-
Welcome to Automicle API documentation, a series of notes and instructions that outline the Automicle API version 1 allowing you tap into **Urban Mobility** features as you build your own **Major Transport** based applications.
The Automicle API provides users with a simple, predictable, standardized, resource-oriented, RESTful interface with JSON-formatted responses that make it easy to search, filter and use our data.
To make integration as streamlined as possible, we use the HTTP protocol for everything we produce, making it easy to access our API with off-the-shelf HTTP clients. Every request to the Automicle API can be easily performed using the cURL command line tool.
### Requests
The Automicle API can be accessed from two enviroments.
- Sandbox Enviroment - For developemnt | https://api.dev.automicle.com/v1/ .
- Product Environment - For production | https://api.prod.automicle.com/v1/
Ensuring consistency with your environment during authentication is very important. Use __X-Automicle-Environment__ to specify the enviroment to obtain a token.
All data exchanges are performed using the JSON format.
### Responses
The Automicle API will respond to successful requests with either a collection of records or a single record in JSON format.
### Errors
The Automicle API uses conventional HTTP status codes to indicate the success or failure of an API request.
Created and managed by Automicle
contact:
name: Automicle
email: support@automicle.com
url: 'https://automicle.com'
servers:
- url: 'https://api.dev.automicle.com/v1'
description: DEV
- url: 'https://api.prod.automicle.com/v1'
description: PROD
paths:
/auth/token:
get:
summary: Authentication
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
example-1:
success: true
data:
access_token: '${ACCESS_TOKEN}'
scope: mobility parking
expires_in: '14400'
token_type: Bearer
error: 'null'
properties:
success:
type: boolean
description: Represents a success or failure response
data:
type: object
properties:
access_token:
type: string
description: Represents the access token used to authorize requests towards all other endpoints.
scope:
type: string
description: Represents the scope of authorization
expires_in:
type: string
description: Represents the lifetime of the token
token_type:
type: string
description: Represents the type of token
error:
type: string
description: Represents an error response
examples:
example-1:
value:
success: true
data:
access_token: '${ACCESS_TOKEN}'
scope: mobility parking
expires_in: '14400'
token_type: Bearer
error: null
operationId: get-v1-auth-token
description: |-
Automicle REST APIs use OAuth 2.0 access tokens to authenticate requests. Your access token authorizes you to use the Automicle REST API server.
To make a request in your integration, you must exchange your client ID and secret for an access token. You can find your client ID and secret by logging in to the Developer Dashboard.
You can make the API call in any programming language. The examples show you how to get your access token.
The authorization token authorizes request to all other endpoints. The token must be included as part of the headers in all other requests on the format: ``` Authorization: Bearer ACCESS_TOKEN ``` .
parameters:
- schema:
type: string
in: header
name: client-id
description: Represents the unique identifier of the client. This is obtained from the developer dashboard.
required: true
- schema:
type: string
in: header
name: client-secret
description: Represents the client secret. This is obtained from the developer dashboard.
required: true
- schema:
type: string
in: header
name: X-Automicle-Environment
description: 'Represents the environment of the application. Accepted values are sandbox, production'
required: true
security: []
parameters: []
/parking/search:
post:
summary: Available Parking
operationId: available-parking
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
example-1:
success: true
data:
- polygons: 'POLYGON ((2.797856471 52.9712142, 2.822460752 52.972056681, 2.827840138 52.990831443, 2.919832433 52.996125033, 2.919691023 52.962319804, 2.919645112 52.9513444, 2.91725803 52.943740077, 2.907283994 52.942742051, 2.907283994 52.942742051, 2.793391095 52.94652491, 2.797856471 52.9712142))'
hourlyParkingPrice: 0
availableZones:
- zoneCoordinates:
lat: 52.978627
lng: 2.869238
zoneId: 19991
itemId: 16d7c535-f208-4249-95e6-0c51e56ed5dc
typeOfParking: BETAALDP
error: null
properties:
success:
type: boolean
description: Represents a success or failure response.
data:
type: array
description: A list of available parking information
items:
type: object
properties:
polygons:
type: string
description: |-
Represents the geometric information about an available parking location.
If a zone id is provided in the request, polygons will not be provided
hourlyParkingPrice:
type: number
description: The hourly parking price.
availableZones:
type: array
description: |-
Represents the available parking zones.
If a zone id is provided in the request, availableZones will not be provided
items:
type: object
properties:
zoneCoordinates:
type: object
description: Represents the location of the parking zone.
properties:
lat:
type: number
description: Represents the latitude of a location.
lng:
type: number
description: Represents the longitude of a location.
zoneId:
type: integer
description: A unique identifier of the parking zone.
itemId:
type: string
description: |-
The unique identifier/reference of the available parking request.
This is required to make an order and payments
typeOfParking:
type: string
description: Represents the type of parking.
error:
type: string
description: Represents an error response
examples:
example-by-location:
value:
success: true
data:
- polygons: 'POLYGON ((2.797856471 52.9712142, 2.822460752 52.972056681, 2.827840138 52.990831443, 2.919832433 52.996125033, 2.919691023 52.962319804, 2.919645112 52.9513444, 2.91725803 52.943740077, 2.907283994 52.942742051, 2.907283994 52.942742051, 2.793391095 52.94652491, 2.797856471 52.9712142))'
hourlyParkingPrice: 0
availableZones:
- zoneCoordinates:
lat: 52.978627
lng: 2.869238
zoneId: 19991
itemId: 16d7c535-f208-4249-95e6-0c51e56ed5dc
typeOfParking: BETAALDP
error: null
example-by-zone:
value:
success: true
data:
- polygons: null
hourlyParkingPrice: 3
availableZones: null
itemId: 59cfbd13-cc8c-410f-9de7-cdb2066903e6
typeOfParking: null
error: null
description: |-
This operation allows you to search for available parkings in two ways. By
- location - By providing specific GPS coordinates
- zoneID - By providing a specific zoneID
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
zoneId: 19993
location:
lat: 52.978627
lng: 2.869238
properties:
zoneId:
type: integer
description: A unique identifier of the parking zone.
location:
type: object
description: 'Represents the GPS coordinates of the location '
properties:
lat:
type: number
description: Represents the latitude of a location.
lng:
type: number
description: Represents the longitude of a location
examples:
zone-id:
value:
zoneId: 19993
location:
value:
location:
lat: 52.978627
lng: 2.869238
description: ''
tags:
- Parking
parameters: []
security:
- Bearer: []
/parking/order/init:
post:
summary: Initialize Order
operationId: initialize-order
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
example-1:
success: true
data:
orderId: '167044714551505'
totalPrice: '6.00'
balanceRequired: '6.00'
adjustedEndDateTime: '2022-12-09T10:00:00.000+00:00'
bookingStartDateTime: '2022-12-09T08:00:00.000+00:00'
bookingEndDateTime: '2022-12-09T10:00:00.000+00:00'
highPriceAlert: false
error: ''
properties:
success:
type: boolean
description: Represents a success or failure response.
data:
type: object
description: Represent the initialize order response
properties:
orderId:
type: string
description: The unique identifier for the request to book a parking location
totalPrice:
type: string
description: The total cost of the order. This is determined by the vehicle type and the parking duration
balanceRequired:
type: string
description: The balance required to complete booking
adjustedEndDateTime:
type: string
description: Repesents the adjusted arrival date and time with the corresponding timezone
format: date-time
bookingStartDateTime:
type: string
description: Represents the arrival date and time with the corresponding timezone
format: date-time
bookingEndDateTime:
type: string
description: Repesents the departure date and time with the corresponding timezone
format: date-time
highPriceAlert:
type: boolean
description: 'Indicates whether or not there is a cap on the minimum amount, usually due to high demand for parking'
error:
type: string
description: Represents an error response
examples:
example-1:
value:
success: true
data:
orderId: '167044714551505'
totalPrice: '6.00'
balanceRequired: '6.00'
adjustedEndDateTime: '2022-12-09T10:00:00.000+00:00'
bookingStartDateTime: '2022-12-09T08:00:00.000+00:00'
bookingEndDateTime: '2022-12-09T10:00:00.000+00:00'
highPriceAlert: false
error: null
tags:
- Parking
description: This operation allows you to initiate a request to book a parking location.
security:
- Bearer: []
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
itemId: 2c888d46-f164-4d2e-b0cf-081126f1bad5
vehicleId: TP299B
bookingStartDateTime: '2022-12-10T13:00:00.00+01:00'
bookingEndDateTime: '2022-12-10T15:00:00.00+01:00'
properties:
itemId:
type: string
description: A unique identifier for the request to book a parking location. This value is obtained from the response for location availability check
vehicleId:
type: string
description: A unique identifier of the vehicle usually the vehicle licence plate number
bookingStartDateTime:
type: string
description: Represents the arrival date and time with the corresponding timezone
format: date-time
bookingEndDateTime:
type: string
format: date-time
description: Repesents the departure date and time with the corresponding timezone
'/parking/order/status/{ORDER_ID}':
parameters:
- schema:
type: string
name: ORDER_ID
in: path
required: true
description: Represents the unique identifier for the request to book a parking location. The is obtained from the request to initialize an order
get:
summary: Check Order
tags:
- Parking
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
example-1:
success: true
data:
startDateTime: '2022-12-10T12:00:00.000+00:00'
endDateTime: '2022-12-10T14:00:00.000+00:00'
totalAmount: 6
orderStatus: INIT_ORDER
error: null
properties:
success:
type: boolean
description: Represents a success or failure response.
data:
type: object
description: Represent the check order response
properties:
startDateTime:
type: string
description: Represents the arrival date and time with the corresponding timezone
format: date-time
endDateTime:
type: string
description: Repesents the departure date and time with the corresponding timezone
format: date-time
totalAmount:
type: number
description: Represent the total cost of the order
orderStatus:
type: string
description: |-
Repesents the current status of the order.
Available values are:
INIT_ORDER : Initialized order
CONFIRMED_ORDER : Confirmed order
COMPLETED : Completed order
TERMINATED : Terminated order
CANCELLED : Cancelled order
error:
type: string
description: Represents an error response
examples:
example-1:
value:
success: true
data:
startDateTime: '2022-12-10T12:00:00.000+00:00'
endDateTime: '2022-12-10T14:00:00.000+00:00'
totalAmount: 6
orderStatus: INIT_ORDER
error: null
operationId: check-order
description: This operation allows you check the current status of an order.
security:
- Bearer: []
post:
summary: Order Pricing
operationId: post-parking-order-status-ORDER_ID
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
example-1:
success: true
data:
remarks: null
refundAmount: 0
payableAmount: 0
startDateTime: '2022-12-09T08:00:00.000+00:00'
proposedEndTime: '2022-12-09T10:00:00.000+00:00'
adjustedEndDateTime: '2022-12-09T10:00:00.000+00:00'
error: null
properties:
success:
type: boolean
description: Represents a success or failure response.
data:
type: object
description: Represent the check order pricing response data
properties:
remarks:
type: string
description: An arbitrary string representing some useful information about the order
refundAmount:
type: number
description: Represents the refund amount. The value is available when a refund exists
payableAmount:
type: number
description: Represent the payable amount for extending an order to the proposed date and time.
startDateTime:
type: string
description: Represents the order start date
format: date-time
proposedEndTime:
type: string
description: Represents the proposed order end date
format: date-time
adjustedEndDateTime:
type: string
description: Represents the final departure date and time
format: date-time
error:
type: string
description: Represents an error response
description: This operation allows you calculate or estimate the outstanding price for an order you want to extend.
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
proposedEndTime: '2022-12-09T10:30:00.000+00:00'
parkingModifyType: UPDATE
properties:
proposedEndTime:
type: string
description: Represents the proposed departure time
parkingModifyType:
type: string
description: |-
Represents the parkingModifyType.
Available values are:
UPDATE : Updates an order
TERMINATE: Terminate an order
CANCEL: Cancel an order
examples:
example-1:
value:
proposedEndTime: '2022-12-09T10:30:00.000+00:00'
parkingModifyType: UPDATE
tags:
- Parking
'/parking/payment/{ORDER_ID}':
parameters:
- schema:
type: string
name: ORDER_ID
in: path
required: true
description: Represents the unique identifier for the request to book a parking location. The is obtained from the request to initialize an order
post:
summary: Complete Payment
operationId: post-parking-payment-ORDER_ID
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
example-1:
success: true
data: Payment successfully completed
error: null
properties:
success:
type: boolean
description: Represents a success or failure response.
data:
type: string
description: An arbitrary text representing a success or failure message
error:
type: string
description: Represents an error response
examples:
example-1:
value:
success: true
data: Payment successfully completed
error: null
description: |-
This operation allows you to attach payment information to a specific order. A payment transaction identifier or reference is required to complete this action.
NB: Automicle is unable to verify the payment however the transaction reference will be attached to the order and stored for future reference. The transction identifier or reference MUST be unique for this operation.
tags:
- Parking
security:
- Bearer: []
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
transactionId: TX_PdkjwnajkLLLLGjgPP
payableAmount: 4
time: '2022-12-06T09:00:00.00+01:00'
properties:
transactionId:
type: string
description: A unique transaction identifier or reference that identifies a successful payment
payableAmount:
type: number
description: Represents the amount paid with reference to the transctionId above.
time:
type: string
description: Represents the payment date and time with the corresponding timezone
format: date-time
examples:
example-1:
value:
transactionId: TX_PdkjwnajkLLLLGjgPP
payableAmount: 4
time: '2022-12-06T09:00:00.00+01:00'
'/parking/order/confirm/{ORDER_ID}':
parameters:
- schema:
type: string
name: ORDER_ID
in: path
required: true
description: Represents the unique identifier for the request to book a parking location. The is obtained from the request to initialize an order
post:
summary: Confirm Order
operationId: post-parking-order-confirm-ORDER_ID
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
example-1:
success: true
data:
startDateTime: '2022-12-09T08:00:00.000+00:00'
endDateTime: '2022-12-09T10:00:00.000+00:00'
remarks: Booking made successfully
payableAmount: 6
refundAmount: null
error: null
properties:
success:
type: boolean
description: Represents a success or failure response.
data:
type: object
description: Represents the confirm order response data
properties:
startDateTime:
type: string
description: Represents the arrival date and time with the corresponding timezone
format: date-time
endDateTime:
type: string
description: Repesents the departure date and time with the corresponding timezone
format: date-time
remarks:
type: string
description: An arbitrary string representing some useful information about the order
payableAmount:
type: number
description: Represents the payable amount for the order
refundAmount:
type: number
description: Represents the refund amount. The value is available when a refund exists
error:
type: string
description: Represents an error response
examples:
example-1:
value:
success: true
data:
startDateTime: '2022-12-09T08:00:00.000+00:00'
endDateTime: '2022-12-09T10:00:00.000+00:00'
remarks: Booking made successfully
payableAmount: 6
refundAmount: null
error: null
description: This operation confirms an initialized order by creating a booking for the order. The payment reference is required to complete this action
security:
- Bearer: []
tags:
- Parking
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
transactionId: TX_PdkjwnajkLLLLGjgPP
properties:
transactionId:
type: string
description: A unique transaction identifier or reference that identifies a successful payment
examples:
example-1:
value:
transactionId: TX_PdkjwnajkLLLLGjgPP
'/parking/order/update/{ORDER_ID}':
parameters:
- schema:
type: string
name: ORDER_ID
in: path
required: true
description: Represents the unique identifier for the request to book a parking location. The is obtained from the request to initialize an order
post:
summary: Extend Parking
operationId: post-parking-order-update-ORDER_ID
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
x-examples:
example-1:
success: true
data:
remarks: ''
refundAmount: 0
payableAmount: 0
startDateTime: '2022-12-09T08:00:00.000+00:00'
proposedEndTime: '2022-12-09T10:00:00.000+00:00'
adjustedEndDateTime: '2022-12-09T10:00:00.000+00:00'
error: ''
properties:
success:
type: boolean
description: Represents a success or failure response
data:
type: object
description: Represents the response data
properties:
remarks:
type: string
description: An arbitrary string representing some useful information about the order
refundAmount:
type: number
description: Represents the refund amount. The value is available when a refund exists
payableAmount:
type: number
description: Represent the payable amount for extending an order to the proposed date and time.
startDateTime:
type: string
description: Represents the order start date
format: date-time
proposedEndTime:
type: string
description: Represents the proposed order end date
format: date-time
adjustedEndDateTime:
type: string
description: Represents the final departure date and time
format: date-time
error:
type: string
description: Represents an error response
examples:
example-1:
value:
success: true
data:
remarks: null
refundAmount: 0
payableAmount: 0
startDateTime: '2022-12-09T08:00:00.000+00:00'
proposedEndTime: '2022-12-09T10:00:00.000+00:00'
adjustedEndDateTime: '2022-12-09T10:00:00.000+00:00'
error: null
description: 'This operation allows you to modify the state of an existing order. This could be an update to extend a parking order, cancel or terminate an existing order.'
security:
- Bearer: []
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
proposedEndTime: '2022-12-09T10:30:00.000+00:00'
parkingModifyType: UPDATE
paymentTransactionId: TX_Pdkjwnajkhdjgg
properties:
proposedEndTime:
type: string
description: Represents the proposed departure time
parkingModifyType:
type: string
description: |-
Represents the parkingModifyType.
Available values are:
UPDATE : Updates an order
TERMINATE: Terminate an order
CANCEL: Cancel an order
paymentTransactionId:
type: string
description: A unique transaction identifier or reference that identifies a successful payment
examples:
example-1:
value:
proposedEndTime: '2022-12-09T10:30:00.000+00:00'
parkingModifyType: UPDATE
paymentTransactionId: TX_Pdkjwnajkhdjgg
tags:
- Parking
/mobility/plannings/offers:
post:
summary: Planning
operationId: post-mobility-plannings-offers
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
validUntil:
type: string
options:
type: array
items:
type: object
properties:
id:
type: string
from:
type: object
properties:
name:
type: string
stopReference:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
country:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
to:
type: object
properties:
name:
type: string
stopReference:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
country:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
customer:
type: object
properties:
id:
type: string
state:
type: string
legs:
type: array
items:
type: object
properties:
id:
type: string
from:
type: object
properties:
name:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
to:
type: object
properties:
name:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
departureTime:
type: string
arrivalTime:
type: string
assetType:
type: object
properties:
id:
type: string
assetClass:
type: string
asset:
type: object
properties:
id:
type: string
suboperator:
type: object
properties:
name:
type: string
description:
type: string
conditions:
type: array
items:
type: object
properties:
ultimateResponseTime:
type: string
requiredFields:
type: array
items:
type: string
state:
type: string
assetAccessData:
type: object
properties:
validFrom:
type: string
validUntil:
type: string
tokenType:
type: string
tokenData:
type: object
properties:
tokenType:
type: string
url:
type: string
departureTime:
type: string
arrivalTime:
type: string
x-examples:
example-1:
validUntil: '2022-10-18T13:22:30.515306+02:00'
options:
- id: e102f086-2878-44de-a221-8d02b85c54fa
from:
name: 'Delft, Julianalaan'
stopReference:
- type: GTFS
id: 'NL:2471008'
country: NL
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Utrecht, Overste den Oudenlaan'
stopReference:
- type: GTFS
id: 'NL:2474877'
country: NL
coordinates:
lng: 5.097684
lat: 52.08309
customer:
id: ''
state: NEW
legs:
- id: 8f7b107d-9a29-4306-85c7-39608f50fe84
from:
name: 'Delft, Julianalaan'
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Delft, Station Delft'
coordinates:
lng: 4.357022
lat: 52.006927
departureTime: '2022-11-10T10:23:05+01:00'
arrivalTime: '2022-11-10T10:27:00+01:00'
assetType:
id: ''
assetClass: BUS
asset:
id: '455'
suboperator:
name: EBS
description: 'http://www.ebs-ov.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
departureTime: '2022-11-10T10:23:05+01:00'
arrivalTime: '2022-11-10T10:23:05+01:00'
examples:
example-1:
value:
validUntil: '2022-10-18T13:22:30.515306+02:00'
options:
- id: e102f086-2878-44de-a221-8d02b85c54fa
from:
name: 'Delft, Julianalaan'
stopReference:
- type: GTFS
id: 'NL:2471008'
country: NL
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Utrecht, Overste den Oudenlaan'
stopReference:
- type: GTFS
id: 'NL:2474877'
country: NL
coordinates:
lng: 5.097684
lat: 52.08309
customer:
id: ''
state: NEW
legs:
- id: 8f7b107d-9a29-4306-85c7-39608f50fe84
from:
name: 'Delft, Julianalaan'
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Delft, Station Delft'
coordinates:
lng: 4.357022
lat: 52.006927
departureTime: '2022-11-10T10:23:05+01:00'
arrivalTime: '2022-11-10T10:27:00+01:00'
assetType:
id: ''
assetClass: BUS
asset:
id: '455'
suboperator:
name: EBS
description: 'http://www.ebs-ov.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
departureTime: '2022-11-10T10:23:05+01:00'
arrivalTime: '2022-11-10T10:23:05+01:00'
tags:
- Mobility
description: This operation allows you to plan/create an offering for an event.
security:
- Bearer: []
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
from:
name: 'Accra, Ghana'
coordinates:
lng: 4.8663115
lat: 52.342116
alt: 0
to:
name: 'Lagos, Nigeria'
coordinates:
lng: 5.08562
lat: 52.11509
alt: 0
departureTime: '2022-12-14T16:48:00.189Z'
nrOfTravelers: 1
properties:
from:
type: object
description: Represents an object that describes the point of origin
properties:
name:
type: string
description: Represents the name of a location
coordinates:
type: object
description: Represents the coordinates of a location
properties:
lng:
type: number
description: Represents the longitude of a location.
lat:
type: number
description: Represents the latitude of a location.
alt:
type: integer
description: Represents the altitude of a location.
to:
type: object
description: Represents an object that describes the destination
properties:
name:
type: string
description: Represents the name of a location
coordinates:
type: object
description: Represents the coordinates of a location
properties:
lng:
type: number
description: Represents the longitude of a location.
lat:
type: number
description: Represents the latitude of a location.
alt:
type: integer
description: Represents the altitude of a location.
departureTime:
type: string
description: Represents the departure time
nrOfTravelers:
type: integer
description: Represents the number of travellers
examples:
example-1:
value:
from:
name: 'Accra, Ghana'
coordinates:
lng: 4.8663115
lat: 52.342116
alt: 0
to:
name: 'Lagos, Nigeria'
coordinates:
lng: 5.08562
lat: 52.11509
alt: 0
departureTime: '2022-12-14T16:48:00.189Z'
nrOfTravelers: 1
description: ''
/mobility/plannings/bookings:
post:
summary: Booking
operationId: post-mobility-plannings-bookings
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
from:
type: object
properties:
name:
type: string
stopReference:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
country:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
to:
type: object
properties:
name:
type: string
stopReference:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
country:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
customer:
type: object
properties:
id:
type: string
state:
type: string
legs:
type: array
items:
type: object
properties:
id:
type: string
from:
type: object
properties:
name:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
to:
type: object
properties:
name:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
departureTime:
type: string
arrivalTime:
type: string
assetType:
type: object
properties:
id:
type: string
assetClass:
type: string
asset:
type: object
properties:
id:
type: string
suboperator:
type: object
properties:
name:
type: string
description:
type: string
conditions:
type: array
items:
type: object
properties:
ultimateResponseTime:
type: string
requiredFields:
type: array
items:
type: string
state:
type: string
assetAccessData:
type: object
properties:
validFrom:
type: string
validUntil:
type: string
tokenType:
type: string
tokenData:
type: object
properties:
tokenType:
type: string
url:
type: string
departureTime:
type: string
arrivalTime:
type: string
x-examples:
example-1:
id: e102f086-2878-44de-a221-8d02b85c54fa
from:
name: 'Delft, Julianalaan'
stopReference:
- type: GTFS
id: 'NL:2471008'
country: NL
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Utrecht, Overste den Oudenlaan'
stopReference:
- type: GTFS
id: 'NL:2474877'
country: NL
coordinates:
lng: 5.097684
lat: 52.08309
customer:
id: ''
state: PENDING
legs:
- id: 8f7b107d-9a29-4306-85c7-39608f50fe84
from:
name: 'Delft, Julianalaan'
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Delft, Station Delft'
coordinates:
lng: 4.357022
lat: 52.006927
departureTime: '2022-11-10T09:23:05Z'
arrivalTime: '2022-11-10T09:27:00Z'
assetType:
id: ''
assetClass: BUS
asset:
id: '455'
suboperator:
name: EBS
description: 'http://www.ebs-ov.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: 17780931-c51c-4bcd-acb2-52057a0540b9
from:
name: 'Delft, Station Delft'
coordinates:
lng: 4.357022
lat: 52.006927
to:
name: Delft
coordinates:
lng: 4.3567414
lat: 52.007362
departureTime: '2022-11-10T09:27:00Z'
arrivalTime: '2022-11-10T09:27:39Z'
assetType:
id: ''
assetClass: FOOT
asset:
id: ''
suboperator:
name: ''
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields: null
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: 2d5a7026-f134-41ed-930b-9de177ccd2ee
from:
name: Delft
coordinates:
lng: 4.3567414
lat: 52.007362
to:
name: Rotterdam Centraal
coordinates:
lng: 4.468694
lat: 51.924667
departureTime: '2022-11-10T09:30:00Z'
arrivalTime: '2022-11-10T09:41:00Z'
assetType:
id: ''
assetClass: RAIL
asset:
id: Intercity
suboperator:
name: NS
description: 'http://www.ns.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
- NAME
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: 44b8085d-42d5-4f85-b010-7c3962a0596a
from:
name: Rotterdam Centraal
coordinates:
lng: 4.468694
lat: 51.924667
to:
name: Rotterdam Centraal
coordinates:
lng: 4.4683046
lat: 51.92552
departureTime: '2022-11-10T09:41:00Z'
arrivalTime: '2022-11-10T09:42:14Z'
assetType:
id: ''
assetClass: FOOT
asset:
id: ''
suboperator:
name: ''
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields: null
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: 0ab48a0d-8d43-45d4-9e8b-0336f94d07aa
from:
name: Rotterdam Centraal
coordinates:
lng: 4.4683046
lat: 51.92552
to:
name: Utrecht Centraal
coordinates:
lng: 5.1096516
lat: 52.089897
departureTime: '2022-11-10T09:50:00Z'
arrivalTime: '2022-11-10T10:27:00Z'
assetType:
id: ''
assetClass: RAIL
asset:
id: Intercity
suboperator:
name: NS
description: 'http://www.ns.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
- NAME
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: a9cf4935-0f03-456d-ac20-09a86f2b8799
from:
name: Utrecht Centraal
coordinates:
lng: 5.1096516
lat: 52.089897
to:
name: 'Utrecht, CS Jaarbeurszijde (Perron C2)'
coordinates:
lng: 5.108281
lat: 52.089256
departureTime: '2022-11-10T10:27:00Z'
arrivalTime: '2022-11-10T10:28:28Z'
assetType:
id: ''
assetClass: FOOT
asset:
id: ''
suboperator:
name: ''
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields: null
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: d1898af2-2c86-4201-ba32-59af472d5301
from:
name: 'Utrecht, CS Jaarbeurszijde (Perron C2)'
coordinates:
lng: 5.108281
lat: 52.089256
to:
name: 'Utrecht, Graadt van Roggenweg'
coordinates:
lng: 5.099994
lat: 52.086838
departureTime: '2022-11-10T10:34:00Z'
arrivalTime: '2022-11-10T10:37:00Z'
assetType:
id: ''
assetClass: BUS
asset:
id: '387'
suboperator:
name: Qbuzz
description: 'http://www.qbuzz.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: d6e15a1f-28fb-446f-b95e-5008367485b5
from:
name: 'Utrecht, Graadt van Roggenweg'
coordinates:
lng: 5.099994
lat: 52.086838
to:
name: 'Utrecht, Overste den Oudenlaan'
coordinates:
lng: 5.097684
lat: 52.08309
departureTime: '2022-11-10T10:42:00Z'
arrivalTime: '2022-11-10T10:44:00Z'
assetType:
id: ''
assetClass: BUS
asset:
id: '7'
suboperator:
name: U-OV
description: 'http://www.u-ov.info'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
departureTime: '2022-11-10T09:23:05Z'
arrivalTime: '2022-11-10T09:23:05Z'
examples:
example-1:
value:
id: e102f086-2878-44de-a221-8d02b85c54fa
from:
name: 'Delft, Julianalaan'
stopReference:
- type: GTFS
id: 'NL:2471008'
country: NL
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Utrecht, Overste den Oudenlaan'
stopReference:
- type: GTFS
id: 'NL:2474877'
country: NL
coordinates:
lng: 5.097684
lat: 52.08309
customer:
id: ''
state: PENDING
legs:
- id: 8f7b107d-9a29-4306-85c7-39608f50fe84
from:
name: 'Delft, Julianalaan'
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Delft, Station Delft'
coordinates:
lng: 4.357022
lat: 52.006927
departureTime: '2022-11-10T09:23:05Z'
arrivalTime: '2022-11-10T09:27:00Z'
assetType:
id: ''
assetClass: BUS
asset:
id: '455'
suboperator:
name: EBS
description: 'http://www.ebs-ov.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: 17780931-c51c-4bcd-acb2-52057a0540b9
from:
name: 'Delft, Station Delft'
coordinates:
lng: 4.357022
lat: 52.006927
to:
name: Delft
coordinates:
lng: 4.3567414
lat: 52.007362
departureTime: '2022-11-10T09:27:00Z'
arrivalTime: '2022-11-10T09:27:39Z'
assetType:
id: ''
assetClass: FOOT
asset:
id: ''
suboperator:
name: ''
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields: null
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: 2d5a7026-f134-41ed-930b-9de177ccd2ee
from:
name: Delft
coordinates:
lng: 4.3567414
lat: 52.007362
to:
name: Rotterdam Centraal
coordinates:
lng: 4.468694
lat: 51.924667
departureTime: '2022-11-10T09:30:00Z'
arrivalTime: '2022-11-10T09:41:00Z'
assetType:
id: ''
assetClass: RAIL
asset:
id: Intercity
suboperator:
name: NS
description: 'http://www.ns.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
- NAME
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: 44b8085d-42d5-4f85-b010-7c3962a0596a
from:
name: Rotterdam Centraal
coordinates:
lng: 4.468694
lat: 51.924667
to:
name: Rotterdam Centraal
coordinates:
lng: 4.4683046
lat: 51.92552
departureTime: '2022-11-10T09:41:00Z'
arrivalTime: '2022-11-10T09:42:14Z'
assetType:
id: ''
assetClass: FOOT
asset:
id: ''
suboperator:
name: ''
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields: null
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: 0ab48a0d-8d43-45d4-9e8b-0336f94d07aa
from:
name: Rotterdam Centraal
coordinates:
lng: 4.4683046
lat: 51.92552
to:
name: Utrecht Centraal
coordinates:
lng: 5.1096516
lat: 52.089897
departureTime: '2022-11-10T09:50:00Z'
arrivalTime: '2022-11-10T10:27:00Z'
assetType:
id: ''
assetClass: RAIL
asset:
id: Intercity
suboperator:
name: NS
description: 'http://www.ns.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
- NAME
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: a9cf4935-0f03-456d-ac20-09a86f2b8799
from:
name: Utrecht Centraal
coordinates:
lng: 5.1096516
lat: 52.089897
to:
name: 'Utrecht, CS Jaarbeurszijde (Perron C2)'
coordinates:
lng: 5.108281
lat: 52.089256
departureTime: '2022-11-10T10:27:00Z'
arrivalTime: '2022-11-10T10:28:28Z'
assetType:
id: ''
assetClass: FOOT
asset:
id: ''
suboperator:
name: ''
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields: null
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: d1898af2-2c86-4201-ba32-59af472d5301
from:
name: 'Utrecht, CS Jaarbeurszijde (Perron C2)'
coordinates:
lng: 5.108281
lat: 52.089256
to:
name: 'Utrecht, Graadt van Roggenweg'
coordinates:
lng: 5.099994
lat: 52.086838
departureTime: '2022-11-10T10:34:00Z'
arrivalTime: '2022-11-10T10:37:00Z'
assetType:
id: ''
assetClass: BUS
asset:
id: '387'
suboperator:
name: Qbuzz
description: 'http://www.qbuzz.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
- id: d6e15a1f-28fb-446f-b95e-5008367485b5
from:
name: 'Utrecht, Graadt van Roggenweg'
coordinates:
lng: 5.099994
lat: 52.086838
to:
name: 'Utrecht, Overste den Oudenlaan'
coordinates:
lng: 5.097684
lat: 52.08309
departureTime: '2022-11-10T10:42:00Z'
arrivalTime: '2022-11-10T10:44:00Z'
assetType:
id: ''
assetClass: BUS
asset:
id: '7'
suboperator:
name: U-OV
description: 'http://www.u-ov.info'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
departureTime: '2022-11-10T09:23:05Z'
arrivalTime: '2022-11-10T09:23:05Z'
tags:
- Mobility
description: This operation allows you to create a booking for an event.
security:
- Bearer: []
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
id: 74736bf2-7a86-4e74-8f62-efa152c44647
customer:
firstName: John
lastName: Doe
middleName: von
email: johndoe@johndoe.com
birthDate: '2000-10-07'
properties:
id:
type: string
description: A unique identifier that represents the planned event. This is obtained as part of the response during the planning stage
customer:
type: object
description: Represents a customer registering for the planned event
properties:
firstName:
type: string
description: Represents the first name of the customer
lastName:
type: string
description: Represents the last name of the customer
middleName:
type: string
description: Represents the other names of the customer
email:
type: string
description: Represents the email of the customer
format: email
birthDate:
type: string
description: Represents the birthdate of the customer
examples:
example-1:
value:
id: 74736bf2-7a86-4e74-8f62-efa152c44647
customer:
firstName: John
lastName: Doe
middleName: von
email: johndoe@johndoe.com
birthDate: '2000-10-07'
'/mobility/plannings/bookings/{BOOKING_ID}/events':
parameters:
- schema:
type: string
name: BOOKING_ID
in: path
required: true
description: Represents the unique identifier for the booking to which the events belong
post:
summary: Events
operationId: post-mobility-plannings-bookings-BOOKING_ID-events
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
validUntil:
type: string
options:
type: array
items:
type: object
properties:
id:
type: string
from:
type: object
properties:
name:
type: string
stopReference:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
country:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
to:
type: object
properties:
name:
type: string
stopReference:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
country:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
customer:
type: object
properties:
id:
type: string
state:
type: string
legs:
type: array
items:
type: object
properties:
id:
type: string
from:
type: object
properties:
name:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
to:
type: object
properties:
name:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
departureTime:
type: string
arrivalTime:
type: string
assetType:
type: object
properties:
id:
type: string
assetClass:
type: string
asset:
type: object
properties:
id:
type: string
suboperator:
type: object
properties:
name:
type: string
description:
type: string
conditions:
type: array
items:
type: object
properties:
ultimateResponseTime:
type: string
requiredFields:
type: array
items:
type: string
state:
type: string
assetAccessData:
type: object
properties:
validFrom:
type: string
validUntil:
type: string
tokenType:
type: string
tokenData:
type: object
properties:
tokenType:
type: string
url:
type: string
departureTime:
type: string
arrivalTime:
type: string
x-examples:
example-1:
validUntil: '2022-10-18T13:22:30.515306+02:00'
options:
- id: e102f086-2878-44de-a221-8d02b85c54fa
from:
name: 'Delft, Julianalaan'
stopReference:
- type: GTFS
id: 'NL:2471008'
country: NL
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Utrecht, Overste den Oudenlaan'
stopReference:
- type: GTFS
id: 'NL:2474877'
country: NL
coordinates:
lng: 5.097684
lat: 52.08309
customer:
id: ''
state: NEW
legs:
- id: 8f7b107d-9a29-4306-85c7-39608f50fe84
from:
name: 'Delft, Julianalaan'
coordinates:
lng: 4.368143
lat: 52.005974
to:
name: 'Delft, Station Delft'
coordinates:
lng: 4.357022
lat: 52.006927
departureTime: '2022-11-10T10:23:05+01:00'
arrivalTime: '2022-11-10T10:27:00+01:00'
assetType:
id: ''
assetClass: BUS
asset:
id: '455'
suboperator:
name: EBS
description: 'http://www.ebs-ov.nl'
conditions:
- ultimateResponseTime: '0001-01-01T00:00:00Z'
requiredFields:
- BIRTHDATE
- EMAIL
state: NOT_STARTED
assetAccessData:
validFrom: '0001-01-01T00:00:00Z'
validUntil: '0001-01-01T00:00:00Z'
tokenType: ''
tokenData:
tokenType: ''
url: ''
departureTime: '2022-11-10T10:23:05+01:00'
arrivalTime: '2022-11-10T10:23:05+01:00'
security:
- Bearer: []
requestBody:
content:
application/json:
schema:
type: object
properties:
operation:
type: string
origin:
type: string
x-examples:
example-1:
operation: COMMIT
origin: TO
examples:
example-1:
value:
operation: COMMIT
origin: TO
tags:
- Mobility
'/mobility/legs/{BOOKING_ID}':
parameters:
- schema:
type: string
name: BOOKING_ID
in: path
required: true
get:
summary: Booking Information
tags:
- Mobility
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
from:
type: object
properties:
name:
type: string
stationId:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
alt:
type: integer
radius:
type: integer
to:
type: object
properties:
name:
type: string
stationId:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
alt:
type: integer
departureTime:
type: string
arrivalTime:
type: string
nrOfTravelers:
type: integer
travelers:
type: array
items:
type: object
properties:
isValidated:
type: boolean
age:
type: integer
referenceNumber:
type: string
cardTypes:
type: array
items:
type: object
properties:
type:
type: string
subType:
type: string
assetClass:
type: string
acceptors:
type: array
items:
type: string
licenseTypes:
type: array
items:
type: object
properties:
assetClass:
type: string
issuingCountry:
type: string
requirements:
type: object
properties:
abilities:
type: array
items:
type: object
properties:
source:
type: string
category:
type: string
number:
type: string
type:
type: string
memo:
type: string
variable-number:
type: integer
applicable-days:
type: array
items:
type: string
bringAlong:
type: array
items:
type: object
properties:
source:
type: string
category:
type: string
number:
type: string
type:
type: string
memo:
type: string
variable-number:
type: integer
applicable-days:
type: array
items:
type: string
additionalProp1:
type: object
properties: {}
knownIdentifier:
type: string
knownIdentifierProvider:
type: string
useAssets:
type: array
items:
type: string
userGroups:
type: array
items:
type: string
useAssetTypes:
type: array
items:
type: string
x-examples:
example-1:
from:
name: 'Delft, Julianalaan'
stationId: 'NL:2471008'
coordinates:
lng: 4.368143
lat: 52.005973
alt: 0
radius: 0
to:
name: 'Utrecht, Overste den Oudenlaan'
stationId: 'NL:2474877'
coordinates:
lng: 5.097684
lat: 52.083093
alt: 0
departureTime: '2022-09-09T14:36:45.189Z'
arrivalTime: '2022-09-08T14:36:45.189Z'
nrOfTravelers: 1
travelers:
- isValidated: true
age: 0
referenceNumber: string
cardTypes:
- type: ID
subType: string
assetClass: AIR
acceptors:
- string
licenseTypes:
- assetClass: AIR
issuingCountry: NL
requirements:
abilities:
- source: string
category: string
number: st
type: string
memo: string
variable-number: 0
applicable-days:
- MO
bringAlong:
- source: string
category: string
number: st
type: string
memo: string
variable-number: 0
applicable-days:
- MO
additionalProp1: {}
knownIdentifier: string
knownIdentifierProvider: string
useAssets:
- string
userGroups:
- string
useAssetTypes:
- string
examples:
example-1:
value:
from:
name: 'Delft, Julianalaan'
stationId: 'NL:2471008'
coordinates:
lng: 4.368143
lat: 52.005973
alt: 0
radius: 0
to:
name: 'Utrecht, Overste den Oudenlaan'
stationId: 'NL:2474877'
coordinates:
lng: 5.097684
lat: 52.083093
alt: 0
departureTime: '2022-09-09T14:36:45.189Z'
arrivalTime: '2022-09-08T14:36:45.189Z'
nrOfTravelers: 1
travelers:
- isValidated: true
age: 0
referenceNumber: string
cardTypes:
- type: ID
subType: string
assetClass: AIR
acceptors:
- string
licenseTypes:
- assetClass: AIR
issuingCountry: NL
requirements:
abilities:
- source: string
category: string
number: st
type: string
memo: string
variable-number: 0
applicable-days:
- MO
bringAlong:
- source: string
category: string
number: st
type: string
memo: string
variable-number: 0
applicable-days:
- MO
additionalProp1: {}
knownIdentifier: string
knownIdentifierProvider: string
useAssets:
- string
userGroups:
- string
useAssetTypes:
- string
operationId: get-mobility-legs-BOOKING_ID
description: This operation returns all events associated with a booking .
security:
- Bearer: []
/mobility/payment/jounral-entry:
get:
summary: Payment Journal Entries
tags:
- Mobility
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
from:
type: object
properties:
name:
type: string
stationId:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
alt:
type: integer
radius:
type: integer
to:
type: object
properties:
name:
type: string
stationId:
type: string
coordinates:
type: object
properties:
lng:
type: number
lat:
type: number
alt:
type: integer
departureTime:
type: string
arrivalTime:
type: string
nrOfTravelers:
type: integer
travelers:
type: array
items:
type: object
properties:
isValidated:
type: boolean
age:
type: integer
referenceNumber:
type: string
cardTypes:
type: array
items:
type: object
properties:
type:
type: string
subType:
type: string
assetClass:
type: string
acceptors:
type: array
items:
type: string
licenseTypes:
type: array
items:
type: object
properties:
assetClass:
type: string
issuingCountry:
type: string
requirements:
type: object
properties:
abilities:
type: array
items:
type: object
properties:
source:
type: string
category:
type: string
number:
type: string
type:
type: string
memo:
type: string
variable-number:
type: integer
applicable-days:
type: array
items:
type: string
bringAlong:
type: array
items:
type: object
properties:
source:
type: string
category:
type: string
number:
type: string
type:
type: string
memo:
type: string
variable-number:
type: integer
applicable-days:
type: array
items:
type: string
additionalProp1:
type: object
properties: {}
knownIdentifier:
type: string
knownIdentifierProvider:
type: string
useAssets:
type: array
items:
type: string
userGroups:
type: array
items:
type: string
useAssetTypes:
type: array
items:
type: string
x-examples:
example-1:
from:
name: 'Delft, Julianalaan'
stationId: 'NL:2471008'
coordinates:
lng: 4.368143
lat: 52.005973
alt: 0
radius: 0
to:
name: 'Utrecht, Overste den Oudenlaan'
stationId: 'NL:2474877'
coordinates:
lng: 5.097684
lat: 52.083093
alt: 0
departureTime: '2022-09-09T14:36:45.189Z'
arrivalTime: '2022-09-08T14:36:45.189Z'
nrOfTravelers: 1
travelers:
- isValidated: true
age: 0
referenceNumber: string
cardTypes:
- type: ID
subType: string
assetClass: AIR
acceptors:
- string
licenseTypes:
- assetClass: AIR
issuingCountry: NL
requirements:
abilities:
- source: string
category: string
number: st
type: string
memo: string
variable-number: 0
applicable-days:
- MO
bringAlong:
- source: string
category: string
number: st
type: string
memo: string
variable-number: 0
applicable-days:
- MO
additionalProp1: {}
knownIdentifier: string
knownIdentifierProvider: string
useAssets:
- string
userGroups:
- string
useAssetTypes:
- string
examples:
example-1:
value:
from:
name: 'Delft, Julianalaan'
stationId: 'NL:2471008'
coordinates:
lng: 4.368143
lat: 52.005973
alt: 0
radius: 0
to:
name: 'Utrecht, Overste den Oudenlaan'
stationId: 'NL:2474877'
coordinates:
lng: 5.097684
lat: 52.083093
alt: 0
departureTime: '2022-09-09T14:36:45.189Z'
arrivalTime: '2022-09-08T14:36:45.189Z'
nrOfTravelers: 1
travelers:
- isValidated: true
age: 0
referenceNumber: string
cardTypes:
- type: ID
subType: string
assetClass: AIR
acceptors:
- string
licenseTypes:
- assetClass: AIR
issuingCountry: NL
requirements:
abilities:
- source: string
category: string
number: st
type: string
memo: string
variable-number: 0
applicable-days:
- MO
bringAlong:
- source: string
category: string
number: st
type: string
memo: string
variable-number: 0
applicable-days:
- MO
additionalProp1: {}
knownIdentifier: string
knownIdentifierProvider: string
useAssets:
- string
userGroups:
- string
useAssetTypes:
- string
operationId: get-mobility-payment-jounral-entry
security:
- Bearer: []
components:
schemas: {}
securitySchemes:
Bearer:
type: http
scheme: bearer
description: The bearer token is required to authorize requests to all other secured endpoints.
parameters:
Authorization:
name: Authorization
in: header
required: true
schema:
type: string
example: Bearer $ACCESS_TOKEN
tags:
- name: Mobility
- name: Parking
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment