productProperties

a product within a package

Type: object

semantics [{'transmodel': 'FARE PRODUCT'}]

---

Properties overview

Property	Type	Required	Description
type	string	✓
id	productReference	✓	default string, full names etc (length 0-200)
name	normalString		default string, full names etc (length 0-200)
description	longString		long string, memos etc (length 0-10.000)
parts	array[productReference]		to be used for composed products.
fare	fareStructure
conditions	array[label]
guarantees	array[guarantee]

Detailed Properties

• type (string) - required
  value: "product"

• id (productReference) - required
  default string, full names etc (length 0-200)

• name (normalString) - optional
  default string, full names etc (length 0-200)

• description (longString) - optional
  long string, memos etc (length 0-10.000)

• parts (array[productReference]) - optional
  to be used for composed products.

• fare (fareStructure) - optional

• conditions (array[label]) - optional

• guarantees (array[guarantee]) - optional
  Array item properties:

  • id (string) - optional
    https://en.wikipedia.org/wiki/Universally_unique_identifier see also https://www.ietf.org/rfc/rfc4122.txt (ae76f51c-a1a6-46af-b9ab-8233564adcae)
  • name (string) - optional
    default string, full names etc (length 0-200)
  • organisation (string) - optional
    guaranteeing organisation
  • type (enum (ALTERNATIVE_JOURNEY, HOME_LEG, RETURN_TO_ORIGIN, ON_TIME_TRAVEL, TRIP_ON_TIME, ...)) - optional
    ALTERNATIVE_JOURNEY - A TRIP REPAIR GUARANTEE that if a designated SERVICE JOURNEY is not available then alternative SERVICE JOURNEY will be provided. -| (EASEMENT_REDRESS, PRODUCT EXCHANGE REDRESS) HOME_LEG - A TRIP REPAIR GUARANTEE that if a the passenger is unable to reach their destination by public transport because of a delay in services, a taxi to their destination will be provided. -| (TAXI HOME REDRESS) RETURN_TO_ORIGIN - A TRIP REPAIR GUARANTEE that if a designated SERVICE JOURNEY cannot be completed, then the passenger will be returned to their origin stop. -| (RETURN TO ORIGIN REDRESS) ON_TIME_TRAVEL - A TRAVEL QUALITY GUARANTEE that compensation will be offered if repeated travel within a certain TIME INTERVAL fails to meet certain performance targets as to arrival times. -| (ALL REDRESSES, needs TEMPORAL PARAMETER) TRIP_ON_TIME - A TRAVEL QUALITY GUARANTEE that compensation will be offered if a trip fails to meet certain performance targets as to arrival times. -| (ALL REDRESSES, needs TEMPORAL PARAMETER) FACILITIES_AVAILABLE - A TRAVEL QUALITY GUARANTEE that compensation will be offered if a facility or service (e.g. WIFI, Meal, seat reservation, etc) is not available or fails to meet a specified quality. -| (ALL REDRESSES, needs SERVICE PARAMETER) MOBILITY_ACCOMODATION - A TRAVEL QUALITY GUARANTEE that special accommodation will be provided in the event of severe disruption. -| (ALL REDRESSES, needs SERVICE PARAMETER) MOBILITY_ASSISTANCE - A TRAVEL QUALITY GUARANTEE that mobility assistance will be provided. -| (ALL REDRESSES, needs SERVICE PARAMETER) PASSENGER_SUPPORT - A TRAVEL QUALITY GUARANTEE that assistance will be provided, for example, if a disruption occurs or a that stations are staffed. (ALL REDRESSES) DISRUPTION_INFORMATION - An INFORMATION QUALITY GUARANTEE that information on disruptions will be made available. (ALL REDRESSES) REDRESS_INFORMATION - An INFORMATION QUALITY GUARANTEE that information on available compensation or other statutory and discretionary redress options will be made available to the passenger. (ALL REDRESSES) BEST_FARE_INFORMATION - An INFORMATION QUALITY GUARANTEE that information on the best value fares will be made available (ALL REDRESSES) GENERAL_TRAVEL - An arbitrary OTHER TRAVEL GUARANTEE describing some special guarantee not covered by the normal categories (ALL REDRESSES) MEDIA_REPLACEMENT - An OTHER GUARANTEE that a replacement media will be provided if the original becomes unusable. REFUND_UNUSED_ANCILLARIES - unused ancillaries will be refunded REFUND_WHEN_CANCELLED - when cancelled before start, a refund will be scheduled

Example

{
  "id": "identifier",
  "type": "product",
  "name": "example-string",
  "description": "example-string",
  "parts": [
    "example-string",
    "example-string"
  ]
}