maas-schemas

response Schema

http://maasglobal.com/tsp/booking-create/response.json

Response schema for creating a booking through a TSP adapter

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Develop	No	Forbidden	Forbidden	tsp/booking-create/response.json

Schema Hierarchy

• response http://maasglobal.com/tsp/booking-create/response.json
  • booking http://maasglobal.com/core/booking.json
  • state http://maasglobal.com/core/components/state.json
  • booking-option http://maasglobal.com/core/booking-option.json
  • booking-meta http://maasglobal.com/core/booking-meta.json
  • configurator http://maasglobal.com/core/components/configurator.json
  • customerSelection http://maasglobal.com/core/components/customerSelection.json

response Example

{
  "leg": {
    "from": {
      "name": "Siltasaarenkatu 1, Helsinki",
      "address": "streetName:Siltasaarenkatu|streetNumber:1|city:Helsinki|zipCode:00530|country:Suomi",
      "lat": 60.177252,
      "lon": 24.950388
    },
    "to": {
      "name": "Ida Aalbergin tie 3, Helsinki",
      "address": "streetName:Ida%20Aalbergin%20tie|streetNumber:1|city:Helsinki|zipCode:00400|country:Suomi",
      "lat": 60.231538,
      "lon": 24.892568
    },
    "startTime": 1572440451838,
    "endTime": 1572441571838,
    "mode": "TAXI",
    "departureDelay": 900000
  },
  "customer": {
    "email": "test@example.com",
    "phone": "+358400001010",
    "locale": "en",
    "clientId": "whim",
    "lastName": "Tester",
    "opaqueId": "cafecaca",
    "firstName": "Test"
  },
  "state": "RESERVED",
  "tspId": "deadbeefdeadbeefdeadcafebeef",
  "terms": {
    "reusable": false,
    "validity": {
      "endTime": 1572355249017,
      "startTime": 1572355193128
    },
    "reconcilable": false
  },
  "tspProduct": {
    "id": "testtaxi1-product1"
  },
  "meta": {
    "MODE_TAXI": {
      "driver": {},
      "taxiCenter": {
        "name": "Taksi Test1",
        "phone": "+358400001010"
      },
      "vehicleType": "any"
    }
  },
  "cost": {
    "amount": 22,
    "currency": "EUR"
  },
  "tspProductId": "testtaxi1-product1",
  "token": {}
}

response Properties

Property	Type	Required	Nullable	Defined by
configurator	configurator	Optional	No	response (this schema)
cost	cost	Optional	No	response (this schema)
customer	customer	Optional	No	response (this schema)
customerSelection	customerSelection	Optional	No	response (this schema)
leg	object	Optional	No	response (this schema)
meta	booking-meta	Required	No	response (this schema)
state	enum	Required	No	response (this schema)
terms	terms	Required	No	response (this schema)
token	object	Required	No	response (this schema)
tspId	string	Required	No	response (this schema)
tspProduct	object	Required	No	response (this schema)

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 optional
• type: customer
• defined in this schema

customer Type

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

customerSelection

customerSelection

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

customerSelection Type

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

leg

A subset of the standard leg (../core/leg.json)

leg

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

leg Type

object with following properties:

Property	Type	Required
agencyId		Optional
departureDelay		Optional
endTime		Required
from		Required
mode		Required
startTime		Required
to		Required

agencyId

agencyId

• is optional
• type: agencyId

agencyId Type

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

departureDelay

departureDelay

• is optional
• type: duration

departureDelay Type

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

endTime

endTime

• is required
• type: time

endTime Type

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

from

Starting location’s lat and lon pair of this request

from

• is required
• type: place

from Type

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

mode

mode

• is required
• type: travel-mode

mode Type

• travel-mode – http://maasglobal.com/core/components/travel-mode.json

startTime

startTime

• is required
• type: time

startTime Type

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

to

to

• is required
• type: place

to Type

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

meta

meta

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

meta Type

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

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

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 required
• type: string
• defined in this schema

tspId Type

string

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

tspProduct

Defines what kind of TSP product the booking option represents.

tspProduct

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

tspProduct Type

object with following properties:

Property	Type	Required
id	string	Required

id

Unique identifier for the product

id

• is required
• type: string

id Type

string

• minimum length: 1 characters
• maximum length: 255 characters

This site is open source. Improve this page.