maas-schemas

request Schema

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

Request 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	Permitted	tsp/booking-create/request.json

Schema Hierarchy

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

request Example

{
  "leg": {
    "to": {
      "lat": 60.1769789,
      "lon": 24.9504135,
      "name": "Ida Aalbergin tie 3, Helsinki",
      "address": "streetName:Ida%20Aalbergin%20tie|streetNumber:1|city:Helsinki|zipCode:00400|country:Suomi"
    },
    "from": {
      "lat": 60.177252,
      "lon": 24.950388,
      "name": "Siltasaarenkatu 1, Helsinki",
      "address": "streetName:Siltasaarenkatu|streetNumber:1|city:Helsinki|zipCode:00530|country:Suomi"
    },
    "mode": "TAXI",
    "endTime": 1572441571838,
    "agencyId": "Test1",
    "startTime": 1572440451838
  },
  "customer": {
    "email": "test@example.com",
    "phone": "+358400001010",
    "locale": "en",
    "clientId": "whim",
    "lastName": "Tester",
    "opaqueId": "cafecaca",
    "firstName": "Test",
    "documents": []
  },
  "meta": {
    "MODE_TAXI": {
      "driver": {},
      "taxiCenter": {
        "name": "Taksi",
        "phone": "+358100000011"
      },
      "vehicleType": "any"
    }
  },
  "terms": {
    "reusable": false,
    "validity": {
      "endTime": 1572355249017,
      "startTime": 1572355193128
    },
    "reconcilable": false
  },
  "configurator": {},
  "customerSelection": {},
  "cost": null,
  "tspId": null,
  "tspProduct": {
    "id": "testtaxi1-product1"
  }
}

request Properties

Property	Type	Required	Nullable	Defined by
configurator	configurator	Optional	No	request (this schema)
customer	customer	Required	No	request (this schema)
customerSelection	customerSelection	Optional	No	request (this schema)
leg	object	Required	No	request (this schema)
meta	booking-meta	Required	No	request (this schema)
terms	terms	Required	No	request (this schema)
tspProduct	object	Required	No	request (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

customer

customer

• is required
• 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 required
• 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

terms

terms

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

terms Type

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

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.