maas-schemas

MODE_TAXI Schema

http://maasglobal.com/core/modes/MODE_TAXI.json

Schema for MODE_TAXI meta field

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Develop	No	Forbidden	Forbidden	core/modes/MODE_TAXI.json

Schema Hierarchy

• MODE_TAXI http://maasglobal.com/core/modes/MODE_TAXI.json
  • units-geo http://maasglobal.com/core/components/units-geo.json
  • units http://maasglobal.com/core/components/units.json

MODE_TAXI Properties

Property	Type	Required	Nullable	Defined by
dispatchOrderId	string	Optional	No	MODE_TAXI (this schema)
driver	object	Optional	No	MODE_TAXI (this schema)
eta	integer	Optional	No	MODE_TAXI (this schema)
messageToDriver	string	Optional	No	MODE_TAXI (this schema)
noShowReportedByDriver	boolean	Optional	No	MODE_TAXI (this schema)
pickupIdentificationCode	string	Optional	No	MODE_TAXI (this schema)
taxiCenter	object	Optional	No	MODE_TAXI (this schema)
vehicleDescription	string	Optional	No	MODE_TAXI (this schema)
vehicleId	string	Optional	No	MODE_TAXI (this schema)
vehicleLocation	object	Optional	No	MODE_TAXI (this schema)
vehicleType	string	Optional	No	MODE_TAXI (this schema)

dispatchOrderId

An internal use only number identifying the dispatch id for inspection

dispatchOrderId

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

dispatchOrderId Type

string

• minimum length: 1 characters
• maximum length: 128 characters

driver

Driver information

driver

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

driver Type

object with following properties:

Property	Type	Required
image	string	Optional
name	string	Optional
phone	string	Optional
rating	number	Optional

image

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

image

• is optional
• type: url

image Type

string

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

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

name

Driver name, e.g. ‘Sergey’ or ‘Jane S.’

name

• is optional
• type: string

name Type

string

• minimum length: 1 characters
• maximum length: 128 characters

phone

phone

• is optional
• type: string

phone Type

string

rating

rating

• is optional
• type: number

rating Type

number

eta

POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time

eta

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

eta Type

integer

• minimum value: 1451606400
• maximum value: 9007199254740991

messageToDriver

Message to the driver with, for example, pick up instructions or any other information

messageToDriver

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

messageToDriver Type

string

• maximum length: 160 characters

noShowReportedByDriver

noShowReportedByDriver

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

noShowReportedByDriver Type

boolean

pickupIdentificationCode

Any code that the user can show/tell to the driver to confirm legitimacy of the ride (name, letters, numbers - depends on the service provider)

pickupIdentificationCode

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

pickupIdentificationCode Type

string

• minimum length: 1 characters
• maximum length: 8 characters

taxiCenter

taxiCenter

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

taxiCenter Type

object with following properties:

Property	Type	Required
image	string	Optional
name	string	Optional
phone	string	Optional

image

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

image

• is optional
• type: url

image Type

string

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

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

name

name

• is optional
• type: string

name Type

string

• minimum length: 1 characters
• maximum length: 64 characters

phone

ITU-T E.164 phone number, see https://www.safaribooksonline.com/library/view/regular-expressions-cookbook/9781449327453/ch04s03.html

phone

• is optional
• type: phone

phone Type

string

All instances must conform to this regular expression

^\+(?:\d){6,14}\d$

• test example: +358401234567

phone Example

+358401234567

vehicleDescription

An arbitrary description of the vehicle, e.g. ‘Black Jaguar’

vehicleDescription

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

vehicleDescription Type

string

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

vehicleId

The taxi id (in the taxi number plate on top of the vehicle)

vehicleId

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

vehicleId Type

string

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

vehicleLocation

Geographic latitude-longitude object in WGS-84 system, see https://en.wikipedia.org/wiki/World_Geodetic_System

vehicleLocation

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

vehicleLocation Type

object with following properties:

Property	Type	Required
lat		Required
lon		Required

lat

lat

• is required
• type: latitude

lat Type

• latitude – #/definitions/latitude

lon

lon

• is required
• type: longitude

lon Type

• longitude – #/definitions/longitude

vehicleType

vehicleType

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

vehicleType Type

string

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

This site is open source. Improve this page.