maas-schemas

car-rental Schema

http://maasglobal.com/core/components/car-rental.json

Base schema for MODE_CAR* metas

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Develop No Forbidden Forbidden core/components/car-rental.json

Schema Hierarchy

car-rental Definitions

Property Type Group
icon url http://maasglobal.com/core/components/car-rental.json#/definitions/instruction
text string http://maasglobal.com/core/components/car-rental.json#/definitions/instruction
title string http://maasglobal.com/core/components/car-rental.json#/definitions/instruction

icon

icon

icon Type

text

text

text Type

string

title

title

title Type

string

car-rental Properties

Property Type Required Nullable Defined by
car object Optional No car-rental (this schema)
description string Required No car-rental (this schema)
id string Optional No car-rental (this schema)
image string Required No car-rental (this schema)
instructions instruction Optional No car-rental (this schema)
name string Required No car-rental (this schema)
pickupInfo string Optional No car-rental (this schema)
returnInfo string Optional No car-rental (this schema)
startEndGeoRegionUrl string Optional No car-rental (this schema)
terms complex Optional No car-rental (this schema)
vendor object Optional No car-rental (this schema)

car

car

car Type

object with following properties:

Property Type Required
classification   Required
damage string Optional
doors array Optional
fuel   Optional
fuelLevel number Optional
location object Optional
luggage array Optional
passengers integer Optional
registrationPlate string Optional
transmission   Optional

classification

classification

classification Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

damage

Any reported damages to the car (if available)

damage

damage Type

string

doors

The number of doors this car model may have - an array of min & max

doors

doors Type

Array type: integer[]

All items must be of the type: integer

fuel

fuel

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

fuel Known Values
Value Description
diesel  
electric  
ethanol  
gasoline  
hybrid  
hydrogen  
lpg  
multifuel  
null  

fuelLevel

The percentage of fuel the car has at the moment

fuelLevel

fuelLevel Type

number

location

Current geo location

location

location Type

object with following properties:

Property Type Required
lat   Required
lon   Required

lat

lat

lat Type

lon

lon

lon Type

luggage

The number of luggage this vehicle will be able to transport - an array of [big, small] luggage

luggage

luggage Type

Array type: integer[]

All items must be of the type: integer

passengers

The number of passengers this vehicle will be able to transport

passengers

passengers Type

integer

registrationPlate

Registration plate (e.g. if we know the actual car already)

registrationPlate

registrationPlate Type

string

transmission

transmission

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

transmission Known Values
Value Description
manual  
automatic  
null  

description

description

description Type

string

id

id

id Type

string

image

Uniform resource locator, see https://en.wikipedia.org/wiki/Uniform_Resource_Locator and https://mathiasbynens.be/demo/url-regex

image

image Type

string

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

^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$

instructions

Additional instruction sections displayed for booking

instructions

instructions Type

Array type: instruction

All items must be of the type:

name

name

name Type

string

pickupInfo

Pickup instructions in HTML format

pickupInfo

pickupInfo Type

string

returnInfo

Return Instructions in HTML format

returnInfo

returnInfo Type

string

startEndGeoRegionUrl

Region in which car can be rented and returned. Url to GeoJSON file

startEndGeoRegionUrl

startEndGeoRegionUrl Type

string

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

^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$

terms

terms

terms Type

Unknown type ``.

{
  "simpletype": "complex"
}

vendor

Some fields have a vendor specific format, but appear in all, or most TSPs

vendor

vendor Type

object with following properties:

Property Type Required
voucher   Optional

voucher

voucher

voucher Type

Unknown type ``.

{
  "simpletype": "complex"
}