maas-schemas

request Schema

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

Request schema for retrieving a ticket from 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-ticket/request.json

Schema Hierarchy

• request http://maasglobal.com/tsp/booking-ticket/request.json
  • booking http://maasglobal.com/core/booking.json

request Properties

Property	Type	Required	Nullable	Defined by
ticket	complex	Required	No	request (this schema)
token	object	Required	No	request (this schema)
tspId	string	Required	No	request (this schema)
*	any	Additional	Yes	this schema allows additional properties

ticket

Ticket path.

ticket

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

ticket Type

Any following options needs to be fulfilled.

Option 1

string

All instances must conform to this regular expression (test examples here):

[a-z]\.[svg|html|pdf]

Option 2

Array type:

All items must be of the type: string

All instances must conform to this regular expression (test examples here):

[a-z]\.[svg|html|pdf]

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

This site is open source. Improve this page.