maas-schemas

booking Schema

http://maasglobal.com/core/booking.json

The base booking object with all fields, to be inherited

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Develop	No	Forbidden	Permitted	core/booking.json

Schema Hierarchy

• booking http://maasglobal.com/core/booking.json
  • state http://maasglobal.com/core/components/state.json
  • state-log http://maasglobal.com/core/components/state-log.json
  • fare http://maasglobal.com/core/components/fare.json
  • booking-meta http://maasglobal.com/core/booking-meta.json
  • product http://maasglobal.com/core/product.json
  • common http://maasglobal.com/core/components/common.json
  • customerSelection http://maasglobal.com/core/components/customerSelection.json

booking Example

{
  "id": "12345678-ABCD-1234-ABCD-123456789ABC",
  "state": "EXPIRED",
  "leg": {
    "to": {
      "lat": 60.184333,
      "lon": 24.835972,
      "name": "Otaranta 6, Espoo",
      "address": "streetName:Otaranta|streetNumber:6|city:Espoo|zipCode:02150|country:Suomi"
    },
    "from": {
      "lat": 60.168442,
      "lon": 24.932205,
      "name": "Urho Kekkosen katu 1, Helsinki",
      "address": "streetName:Urho Kekkosen katu|streetNumber:1|city:Helsinki|zipCode:00100|country:Suomi"
    },
    "mode": "TAXI",
    "endTime": 1553092978009,
    "agencyId": "Valopilkku",
    "startTime": 1553092978009,
    "departureDelay": 123456
  },
  "token": {
    "type": "SECURITY_CODE",
    "value": "12345"
  },
  "terms": {
    "reusable": false,
    "validity": {
      "endTime": 1553092978009,
      "startTime": 1553092978009
    },
    "reconcilable": false
  },
  "meta": {
    "raw": {
      "data": {
        "lat": 60.168442,
        "lon": 24.932205,
        "vehicle_id": "123"
      },
      "order_id": 12345,
      "timestamp": "2019-03-20T10:10:12+00:00",
      "localized_description": "Tilaus on valmis."
    },
    "MODE_TAXI": {
      "vehicleId": "123",
      "taxiCenter": {
        "name": "Lähitaksi",
        "phone": "+3581007300"
      },
      "vehicleType": "any",
      "vehicleLocation": {
        "lat": 60.245254,
        "lon": 24.989604
      }
    },
    "timestamp": 1553092978009,
    "valopilkku": {
      "prepaid": true,
      "locations": [
        {
          "type": "pickup",
          "address": {
            "city": "Helsinki",
            "street_address": "Urho Kekkosen katu 1"
          },
          "contacts": [
            {
              "name": "John Doe",
              "passenger_count": 1,
              "provider_order_id": "MaaS-12345"
            }
          ],
          "coordinate": {
            "lat": 60.168442,
            "lon": 24.932205
          },
          "passenger_count": 1
        },
        {
          "type": "destination",
          "address": {
            "city": "Espoo",
            "street_address": "Otaranta 6"
          },
          "drop_off": ["MaaS-12345"],
          "coordinate": {
            "lat": 60.184333,
            "lon": 24.835972
          },
          "passenger_count": 1
        }
      ],
      "submitted": "2019-03-21T11:13:19.753Z"
    },
    "description": "Tilaus on valmis."
  },
  "created": "2019-03-20 10:10:12.123456",
  "modified": "2019-03-20 18:30:12.123456",
  "cost": {
    "amount": 0,
    "currency": "EUR"
  },
  "stateLog": [
    {
      "reason": {},
      "invalid": false,
      "newState": "PENDING",
      "oldState": "START",
      "timestamp": 1553092178009
    },
    {
      "reason": {},
      "invalid": false,
      "newState": "PAID",
      "oldState": "PENDING",
      "timestamp": 1553092278009
    },
    {
      "reason": {},
      "invalid": false,
      "newState": "RESERVED",
      "oldState": "PAID",
      "timestamp": 1553092378009
    },
    {
      "reason": {},
      "invalid": false,
      "newState": "CONFIRMED",
      "oldState": "RESERVED",
      "timestamp": 1553092478009
    },
    {
      "reason": {},
      "invalid": false,
      "newState": "ACTIVATED",
      "oldState": "CONFIRMED",
      "timestamp": 1553092578009
    },
    {
      "reason": {},
      "invalid": false,
      "newState": "EXPIRED",
      "oldState": "ACTIVATED",
      "timestamp": 1553092678009
    }
  ],
  "productId": "valopilkku-any",
  "fares": [
    {
      "type": "charge",
      "amount": 1000,
      "currency": "WMP",
      "productionAmount": 1234
    }
  ],
  "cancelling": false,
  "customer": {
    "identityId": "eu-west-1:4828507e-683f-41bf-9d87-689808fbf958"
  }
}

booking Definitions

Property	Type	Group
agencyId	agencyId	http://maasglobal.com/core/booking.json#/definitions/leg
arrivalDelay	arrivalDelay	http://maasglobal.com/core/booking.json#/definitions/leg
data	object	http://maasglobal.com/core/booking.json#/definitions/token
departureDelay	departureDelay	http://maasglobal.com/core/booking.json#/definitions/leg
distance	distance	http://maasglobal.com/core/booking.json#/definitions/leg
endTime	endTime	http://maasglobal.com/core/booking.json#/definitions/leg
from	from	http://maasglobal.com/core/booking.json#/definitions/leg
legGeometry	legGeometry	http://maasglobal.com/core/booking.json#/definitions/leg
mode	mode	http://maasglobal.com/core/booking.json#/definitions/leg
productOption	productOption	http://maasglobal.com/core/booking.json#/definitions/leg
route	route	http://maasglobal.com/core/booking.json#/definitions/leg
routeLongName	routeLongName	http://maasglobal.com/core/booking.json#/definitions/leg
routeShortName	routeShortName	http://maasglobal.com/core/booking.json#/definitions/leg
startTime	startTime	http://maasglobal.com/core/booking.json#/definitions/leg
stops	stops	http://maasglobal.com/core/booking.json#/definitions/leg
to	to	http://maasglobal.com/core/booking.json#/definitions/leg
tspProduct	tspProduct	http://maasglobal.com/core/booking.json#/definitions/leg
validityDuration	object	http://maasglobal.com/core/booking.json#/definitions/token

agencyId

agencyId

• is optional
• type: agencyId
• defined in this schema

agencyId Type

• agencyId – http://maasglobal.com/core/leg.json#/definitions/agencyId

arrivalDelay

arrivalDelay

• is optional
• type: arrivalDelay
• defined in this schema

arrivalDelay Type

• arrivalDelay – http://maasglobal.com/core/leg.json#/definitions/arrivalDelay

data

Arbitrary ticket data for the client

data

• is optional
• type: object
• defined in this schema

data Type

object with following properties:

| Property | Type | Required | | ——– | —- | ——– |

departureDelay

departureDelay

• is optional
• type: departureDelay
• defined in this schema

departureDelay Type

• departureDelay – http://maasglobal.com/core/leg.json#/definitions/departureDelay

distance

distance

• is optional
• type: distance
• defined in this schema

distance Type

• distance – http://maasglobal.com/core/leg.json#/definitions/distance

endTime

endTime

• is optional
• type: endTime
• defined in this schema

endTime Type

• endTime – http://maasglobal.com/core/leg.json#/definitions/endTime

from

from

• is optional
• type: from
• defined in this schema

from Type

• from – http://maasglobal.com/core/leg.json#/definitions/from

legGeometry

legGeometry

• is optional
• type: legGeometry
• defined in this schema

legGeometry Type

• legGeometry – http://maasglobal.com/core/leg.json#/definitions/legGeometry

mode

mode

• is optional
• type: mode
• defined in this schema

mode Type

• mode – http://maasglobal.com/core/leg.json#/definitions/mode

productOption

productOption

• is optional
• type: productOption
• defined in this schema

productOption Type

• productOption – http://maasglobal.com/core/leg.json#/definitions/productOption

route

route

• is optional
• type: route
• defined in this schema

route Type

• route – http://maasglobal.com/core/leg.json#/definitions/route

routeLongName

routeLongName

• is optional
• type: routeLongName
• defined in this schema

routeLongName Type

• routeLongName – http://maasglobal.com/core/leg.json#/definitions/routeLongName

routeShortName

routeShortName

• is optional
• type: routeShortName
• defined in this schema

routeShortName Type

• routeShortName – http://maasglobal.com/core/leg.json#/definitions/routeShortName

startTime

startTime

• is optional
• type: startTime
• defined in this schema

startTime Type

• startTime – http://maasglobal.com/core/leg.json#/definitions/startTime

stops

stops

• is optional
• type: stops
• defined in this schema

stops Type

• stops – http://maasglobal.com/core/leg.json#/definitions/stops

to

to

• is optional
• type: to
• defined in this schema

to Type

• to – http://maasglobal.com/core/leg.json#/definitions/to

tspProduct

tspProduct

• is optional
• type: tspProduct
• defined in this schema

tspProduct Type

• tspProduct – http://maasglobal.com/core/leg.json#/definitions/tspProduct

validityDuration

The rules that MaaS will interpret to schedule, re-validate or cancel the booking.

validityDuration

• is optional
• type: object
• defined in this schema

validityDuration Type

object with following properties:

Property	Type	Required
endTime		Optional
startTime		Optional

endTime

The finishing time the ticket is valid for

endTime

• is optional
• type: time

endTime Type

• time – http://maasglobal.com/core/components/units.json#/definitions/time

startTime

The starting time from which the ticket is valid

startTime

• is optional
• type: time

startTime Type

• time – http://maasglobal.com/core/components/units.json#/definitions/time

booking Properties

Property	Type	Required	Nullable	Defined by
configurator	configurator	Optional	No	booking (this schema)
cost	cost	Optional	No	booking (this schema)
customer	complex	Required	No	booking (this schema)
customerSelection	customerSelection	Optional	No	booking (this schema)
fares	fare	Optional	No	booking (this schema)
id	id	Required	No	booking (this schema)
leg	object	Required	No	booking (this schema)
meta	booking-meta	Required	No	booking (this schema)
product	product	Optional	No	booking (this schema)
signature	string	Optional	No	booking (this schema)
state	enum	Required	No	booking (this schema)
stateLog	state-log	Optional	No	booking (this schema)
terms	terms	Required	No	booking (this schema)
token	object	Required	No	booking (this schema)
tspId	string	Optional	No	booking (this schema)
*	any	Additional	Yes	this schema allows additional properties

configurator

configurator

• is optional
• type: configurator
• defined in this schema

configurator Type

• configurator – http://maasglobal.com/core/components/configurator.json

cost

cost

• is optional
• type: cost
• defined in this schema

cost Type

• cost – http://maasglobal.com/core/components/cost.json

customer

MaaS booking customer

customer

• is required
• type: complex
• defined in this schema

customer Type

All of the following requirements need to be fulfilled.

Requirement 1

• customer – http://maasglobal.com/core/customer.json

Requirement 2

customerSelection

customerSelection

• is optional
• type: customerSelection
• defined in this schema

customerSelection Type

• customerSelection – http://maasglobal.com/core/components/customerSelection.json

fares

fares

• is optional
• type: fare
• defined in this schema

fares Type

Array type: fare

All items must be of the type:

• fare – http://maasglobal.com/core/components/fare.json

id

id

• is required
• type: id
• defined in this schema

id Type

• id – http://maasglobal.com/core/components/units.json#/definitions/uuid

leg

MaaS response may return any subset of legCore

leg

• is required
• type: object
• defined in this schema

leg Type

object with following properties:

Property	Type	Required
agencyId		Optional
arrivalDelay		Optional
departureDelay		Optional
distance		Optional
endTime		Optional
from		Optional
legGeometry		Optional
mode		Optional
productOption		Optional
route		Optional
routeLongName		Optional
routeShortName		Optional
signature		Optional
startTime		Optional
state		Optional
stops		Optional
to		Optional
tspProduct		Optional

agencyId

agencyId

• is optional
• type: agencyId

agencyId Type

• agencyId – http://maasglobal.com/core/leg.json#/definitions/agencyId

arrivalDelay

arrivalDelay

• is optional
• type: arrivalDelay

arrivalDelay Type

• arrivalDelay – http://maasglobal.com/core/leg.json#/definitions/arrivalDelay

departureDelay

departureDelay

• is optional
• type: departureDelay

departureDelay Type

• departureDelay – http://maasglobal.com/core/leg.json#/definitions/departureDelay

distance

distance

• is optional
• type: distance

distance Type

• distance – http://maasglobal.com/core/leg.json#/definitions/distance

endTime

endTime

• is optional
• type: endTime

endTime Type

• endTime – http://maasglobal.com/core/leg.json#/definitions/endTime

from

from

• is optional
• type: from

from Type

• from – http://maasglobal.com/core/leg.json#/definitions/from

legGeometry

legGeometry

• is optional
• type: legGeometry

legGeometry Type

• legGeometry – http://maasglobal.com/core/leg.json#/definitions/legGeometry

mode

mode

• is optional
• type: mode

mode Type

• mode – http://maasglobal.com/core/leg.json#/definitions/mode

productOption

productOption

• is optional
• type: productOption

productOption Type

• productOption – http://maasglobal.com/core/leg.json#/definitions/productOption

route

route

• is optional
• type: route

route Type

• route – http://maasglobal.com/core/leg.json#/definitions/route

routeLongName

routeLongName

• is optional
• type: routeLongName

routeLongName Type

• routeLongName – http://maasglobal.com/core/leg.json#/definitions/routeLongName

routeShortName

routeShortName

• is optional
• type: routeShortName

routeShortName Type

• routeShortName – http://maasglobal.com/core/leg.json#/definitions/routeShortName

signature

signature

• is optional
• type: signature

signature Type

• signature – http://maasglobal.com/core/components/common.json#/definitions/signature

startTime

startTime

• is optional
• type: startTime

startTime Type

• startTime – http://maasglobal.com/core/leg.json#/definitions/startTime

state

state

• is optional
• type: state

state Type

• state – http://maasglobal.com/core/leg.json#/definitions/state

stops

stops

• is optional
• type: stops

stops Type

• stops – http://maasglobal.com/core/leg.json#/definitions/stops

to

to

• is optional
• type: to

to Type

• to – http://maasglobal.com/core/leg.json#/definitions/to

tspProduct

tspProduct

• is optional
• type: tspProduct

tspProduct Type

• tspProduct – http://maasglobal.com/core/leg.json#/definitions/tspProduct

meta

meta

• is required
• type: booking-meta
• defined in this schema

meta Type

• booking-meta – http://maasglobal.com/core/booking-meta.json

product

product

• is optional
• type: product
• defined in this schema

product Type

• product – http://maasglobal.com/core/product.json

signature

Signature of a signed object

signature

• is optional
• type: string
• defined in this schema

signature Type

string

• minimum length: 1 characters
• maximum length: 1024 characters

state

The life-cycle state of a booking

state

• is required
• type: enum
• defined in this schema

The value of this property must be equal to one of the known values below.

state Known Values

Value	Description
START
PENDING
PAID
RESERVED
CONFIRMED
ARRIVED
ACTIVATED
ON_HOLD
CANCELLED
EXPIRED
REJECTED
FINISHED
UNKNOWN

stateLog

stateLog

• is optional
• type: state-log
• defined in this schema

stateLog Type

• state-log – http://maasglobal.com/core/components/state-log.json

terms

terms

• is required
• type: terms
• defined in this schema

terms Type

• terms – http://maasglobal.com/core/components/terms.json

token

The validity token (such as booking ID, travel ticket etc.) that MaaS clients will display to validate the trip when starting the leg.

token

• is required
• type: object
• defined in this schema

token Type

object with following properties:

Property	Type	Required
data	object	Optional
meta	object	Optional
validityDuration	object	Optional

data

Arbitrary ticket data for the client

data

• is optional
• type: object

data Type

object with following properties:

| Property | Type | Required | | ——– | —- | ——– |

meta

Arbitrary metadata the TSP may pass along the ticket to the client (e.g. a booking code, base64 encoded binary)

meta

• is optional
• type: object

meta Type

object with following properties:

| Property | Type | Required | | ——– | —- | ——– |

validityDuration

The rules that MaaS will interpret to schedule, re-validate or cancel the booking.

validityDuration

• is optional
• type: object

validityDuration Type

object with following properties:

Property	Type	Required
endTime		Optional
startTime		Optional

endTime

The finishing time the ticket is valid for

endTime

• is optional
• type: time

endTime Type

• time – http://maasglobal.com/core/components/units.json#/definitions/time

startTime

The starting time from which the ticket is valid

startTime

• is optional
• type: time

startTime Type

• time – http://maasglobal.com/core/components/units.json#/definitions/time

tspId

tspId

• is optional
• type: string
• defined in this schema

tspId Type

string

• minimum length: 1 characters
• maximum length: 256 characters

This site is open source. Improve this page.