Ticket data model

agency.logo

string (image)

PHN2ZyB3aWR0aD0iNzExL...

base64 encoded image of the logo

agency.name

string

agency_name

agency.url

string (url)

agency_url

created_at

string (datetime)

2020-06-25T13:00:00.000Z

Timestamp when ticket is created

customer_type.description

string

Student ticket is for students only. Valid student card must be presented on ticket inspection.

Description of agency specific customer type

rider_category_description

customer_type.name

string

adult

Agency specific customer type eg. "adult", "senior", "student"

rider_category_name

html

string

...ticket...

Ticket in HTML format

id

string

be78e1f9-e4a4-48d2-b9fe-50aa335e5371

Unifying identifier for a single ticket. Can be used to reference a single ticket of a booking.

locale

string

fi

The locale that has been used to render the ticket and fetch descriptions,instructions etc. eg. "fi", "sv", "en"

see GTFS feed translations.txt

maas_operator_id

string

be78e1f9-e4a4-48d2-b9fe-50aa335e5371

ID of the MaaS operator that executed the purchase requests of the booking originally provided by the MaaS API

price.amount_excluding_vat

number

8.5

Price amount excluding VAT

price.amount_total

number

10

Price amount including VAT

price (fare_rider_categories)

price.currency

string

EUR

Price currency

currency (fare_rider_categories)

price.vat_amount

number

1.5

VAT amount

price.vat_percentage

string

15%

VAT percentage

qr_code

string (image)

data:image/png;base64,iVBORw0KGg...

base64 encoded image of the qr code

receipt_number

string

1A2B3C4D5E6F7G8H

Generated by ticket system

refresh_at

string (date)

2020-06-25T13:00:00.000Z

For the use of HSL-style animated tickets to be inspected manually

route.description

string

This describes the route

Route description

route_description

route.legs

array

[{ stops: [ ... ] }]

All the legs of the route a an array

route.legs.stops

array

[{ name: "...", location: { ... }, stopTime: "..." }]

All the stops of a leg as an array

route.legs.stops.location.lat

string (coordinate)

60.16783393799385

Latitude of the stop

stop_lat

route.legs.stops.location.lon

string (coordinate)

24.952470228154326

Longitude of the stop

stop_lon

route.legs.stops.name

string

Kauppatori, Lyypekinlaituri

Name of the stop

stop_name

route.legs.stops.stop_time

string (datetime)

2020-09-30T12:00:00.000Z

Departure time of the vessel from a particular stop

departure_time

route.name

string

Kauppatori-Lonna-Suomenlinna

Route name

route_name

schema_version

number

1

Version of the ticket data model schema to be used

status

string (enum)

CONFIRMED

Status of a single ticket. Valid values for this fields will be finalized soon.

terms_url

string

http://www.terms.and.conditions.fi

Link to Terms of use declaration page on providers web site

ticket_type.description

string

Ticket allows unrestricted travel between islands xx, xx, xx in hop-on-hop-off style within the same day as ticket has been validated for the first time.

fare_description

ticket_type.instructions

string

• Ticket is valid until 03.00 AM.

• Ticket is read and activated when boarding the vessel.

• Please arrive 15 minutes prior the departure

Ticket rules and special instructions for using the ticket

fare_instructions

ticket_type.name

string

single

Agency specific ticket type eg. single, return, day-ticket

fare_name

validity.activated_at

string (datetime)

2020-08-15T00:00:00.000Z

Timestamp when ticket is activated (depends on the case whether this happens on first ticket scan or at moment of purchase)

validity.deactivates_at

string (datetime)

2020-08-15T00:00:00.000Z

Depending on the ticket type and set rules. Can be set when ticket is activated. If the field is undefined, expiry can't resolved by MaaS operator.

validity.ends_at

string (datetime)

2020-09-30T00:00:00.000Z

Ticket validity end date & time. Ticket cannot be active after this. For open tickets this the end of the time frame that ticket has to be used.

validity.starts_at

string (datetime)

2020-05-01T12:00:00.000Z

Ticket validity start date & time. Ticket cannot be active before this. For open tickets this is the time frame that ticket has to be used.