Schemas latest | Entur for Developers

Cell

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:Cell:5zoneAdult

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

FarePrice · required

A description of the price and factor for a set fare

nameOfClass

string · required

Name of class.

Example: Cell

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References to for example geographical interval and UserProfile

TextInLanguage[]

Name.

TextInLanguage[]

Description.

channelGroupRef

object

Channel group reference

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

Count

numberOfElements

integer · int32 · required

number of elements

Example: 369

Tariff

A tariff

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Tariff:Ordinary

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Tariffs version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: Tariff

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Tariff Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

tariffBasis

string · enum

TariffBasis.

Enum values:

NEW

REVISE

DELETE

Example: NEW

organisationId

string

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

returnFareTwiceSingle

boolean

returnFareTwiceSingle

compatibleWithVersionRef

string

Compatible with version.

DayType

The DayType describe during which the assignment applies

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:DayType:BicycleFlatFare

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: DayType

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name of day type

dayLength

string

Day length. Represented as a string formatted according to ISO-8601

Example: PT04H

PropertyOfDay[]

Properties of day

TextInLanguage[]

Description of day type

earliestTime

string

Earliest time.

Example: 11:11:11

VersionOfObjectRef[]

Time band references.

durationAfterPropertiesOfDay

string

Duration after properties of day. Represented as a string formatted according to ISO-8601

Example: PT7H

durationBeforePropertiesOfDay

string

Duration before properties of day. Represented as a string formatted according to ISO-8601

Example: PT24H

Version

A case class for versioning.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:Version:RuterSingleTicket

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Default: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

nameOfClass

string · readOnly · required

Name of class

Example: Version

versionType

string · enum · required

VersionType.

Enum values:

BASELINE

POINT

modification

string · enum · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

endDate

string · date-time

EndDate

startDate

string · date-time

StartDate

description

string

Description.

Metadata

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:SalesPackage:Ordinary

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: JourneyPattern

responsible

string · minLength: 1 · required

Responsible

Example: Kari Nordmann

note

string

Note

Example: Dette er en endring

externalReferenceUrl

string

External reference URL

externalReferenceName

string

External reference name

Rounding

A description of how prices are rounded post calculation

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Rounding:Ordinary

status

string · enum · readOnly · required

Rounding status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Rounding version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: Rounding

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

roundingMethod

string · enum · required

Type of rounding.

Enum values:

NONE

DOWN

UP

SPLIT

STEP_TABLE

FIVE

NINE

TEN

TextInLanguage[]

Name.

TextInLanguage[]

Description.

roundingModulus

number · double

Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

Timeband

The TimeBand describe during which the assignment applies

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Timeband:2HoursValidPlus1

TextInLanguage[] · required

The name of the luggage allowance represented in different languages. Language codes are ISO-639

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

endTime

string · required

End time.

Example: 11:11:11

dayOffset

integer · int32 · required

Days offset. This will determine if endTime is x number of days from today. ie. 1 is tomorrow 0 is today.

Example: 1

startTime

string · required

Start time.

Example: 11:11:11

TextInLanguage[] · required

Description represented in different languages. Language codes are ISO-639

nameOfClass

string · readOnly · required

Name of class.

Example: TimeBand

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

timeZone

string

Time zone.

Example: Europe/Oslo

Default: Europe/Oslo

ValidityCondition[]

ValidityConditions sequence.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

BoxedUnit

FareFrame

A FareFrame

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FareFrame:Child

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

nameOfClass

string · readOnly · required

Name of class.

Example: FareFrame

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

FareFrame Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

FareFrame version.

Example: NSB:Version:V1

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

vehicleMode

string · enum

Vehicle mode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

FareProducts.

SalesPackages.

ValidableElements.

Fare frame ref.

Validity condition.

derivedFromVersionRef

string · readOnly

Derived from version.

FareStructureElement[]

FareStructureElements.

typeOfFareFrameNetexId

string

Type of fareFrame netexId.

typeOfFareFrameVersion

string

Type of fareFrame version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

transportOrganisationRef

string

Transport organisation ref.

Example: CHILD

transportOrganisationNetexId

string

Transport organisation netexId.

transportOrganisationVersion

string

Transport organisation version.

Example: 4

transportOrganisationNameOfClass

string

Transport organisation nameOfClass.

Example: 16

FarePrice

A description of the price and factor for a set fare

id

string · minLength: 1 · required

Id.

Example: NSB:FarePrice:1005TEN

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

nameOfClass

string · readOnly · required

Name of class.

Example: FarePrice

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name.

amount

string

Amount

Example: 164.0

ranking

integer · int32

Ranking.

Example: 1

version

string · readOnly

Version.

Example: NSB:Version:V1

currency

string

Currency.

Example: NOK

isAllowed

boolean

isAllowed.

Example: true

VersionOfObjectRef

Fare frame ref.

LimitingRule

A LimitingRule

canBeCumulative

boolean

canBeCumulative.

Example: true

vatRegisterGroup

string · enum

vatRegisterGroup.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

derivedFromVersionRef

string

Derived from version.

discountPercentageUsed

integer · int32 · min: -100 · max: 100

discountPercentageUsed.

Example: 5

compatibleWithVersionRef

string

Compatible with version.

FareTable

A FareTable

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FareTable:Ordinary

Cell[] · required

Cell

FarePrice[] · required

FarePrice.

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: FareTable

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name.

endDate

string · date

EndDate.

Example: 2017-11-11

startDate

string · date

StartDate.

Example: 2017-11-11

TextInLanguage[]

Description.

organisationId

string · readOnly

Organisation related to the fare table

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

Refunding

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Refunding:FullRefundUntilLimit

status

string · enum · required

Refunding status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

allowed

string · enum · required

Allowed.

Enum values:

NONE

PARTIAL

FULL

Example: FULL

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Refunding version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: Refunding

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References for associated fare tables.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

hasFee

boolean

Has fee.

FarePrice[]

Prices in different currencies for the refunding rule.

refundType

string · enum

Refund type.

Enum values:

UNUSED

DELAY

CANCELLATION

PARTIAL_JOURNEY

OTHER

Example: UNUSED

resellWhen

string · enum

Event marking when the refundable status of the ticket changes.

Enum values:

NEVER

BEFORE_START_OF_VALIDITY_PERIOD

AFTER_START_OF_VALIDITY_PERIOD

AFTER_END_OF_VALIDITY_PERIOD

BEFORE_FIRST_USE

AFTER_FIRST_USE

BEFORE_VALIDATION

AFTER_VALIDATION

Example: NEVER

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

refundBasis

string · enum

Basis on which refund is made. See allowed values below.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

limitingRule

string

Pricing rule.

canChangeClass

boolean

Whether user can change class.

VersionOfObjectRef

Fare frame ref.

unusedTicketsOnly

boolean

Unused tickets only.

derivedFromVersionRef

string

Derived from version.

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

compatibleWithVersionRef

string

Compatible with version.

exchangeableFromDuration

string

Exchangeable from duration.

Example: PT24H

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration

string

Exchangeable until duration.

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

Replacing

A Replacing

id

string · minLength: 1 · required

Id.

Example: NSB:Replacing:SomeId

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · required

The version of the replacing.

Example: ENT:Version:SomeVersion

nameOfClass

string · readOnly · required

Name of class

Example: Replacing

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References for associated fare table.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

hasFee

boolean

Has fee.

FarePrice[]

Fare prices for the replacing.

allowed

string · enum

Allowed.

Enum values:

NONE

PARTIAL

FULL

resellWhen

string · enum

Event marking when the exchangeable status of the ticket changes.

Enum values:

NEVER

BEFORE_START_OF_VALIDITY_PERIOD

AFTER_START_OF_VALIDITY_PERIOD

AFTER_END_OF_VALIDITY_PERIOD

BEFORE_FIRST_USE

AFTER_FIRST_USE

BEFORE_VALIDATION

AFTER_VALIDATION

Example: NEVER

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

refundBasis

string · enum

Basis on which refund is made. See allowed values below.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

canChangeClass

boolean

Whether user can change class.

unusedTicketsOnly

boolean

Unused tickets only.

ValidityCondition[]

Gives a sequence of conditions for validity.

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string · readOnly

Derived from version.

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

compatibleWithVersionRef

string · readOnly

Compatible with version.

exchangeableFromDuration

string

Exchangeable from duration.

Example: PT24H

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration

string

Exchangeable until duration.

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

Reserving

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Reserving:SeatAsAccommodationReserving

status

string · enum · required

Reserving status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Reserving version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: Reserving

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References for associated fare tables.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Prices in different currencies for the reserving rule.

feeBasis

string · enum

Fee basis.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

LimitingRule

A LimitingRule

VersionOfObjectRef

Fare frame ref.

typeOfUsageParameter

string

Type of usage parameter for the reservation.

Example: NSB:TypeOfUsageParameter:OpenSeating

derivedFromVersionRef

string

Derived from version.

reservationChargeType

string · enum

Type of charge for reservation.

Enum values:

NONE

SINGLE_FEE_FOR_RETURN_TRIP

FEE_FOR_EACH_DIRECTION

FEE_FOR_EACH_LEG

Example: NONE

reservingRequirements

string · enum

Requirements for reservation.

Enum values:

RESERVATIONS_COMPULSORY

RESERVATIONS_COMPULSORY_FOR_GROUPS

RESERVATIONS_COMPULSORY_FOR_FIRST_CLASS

RESERVATIONS_COMPULSORY_FROM_ORIGIN_STATION

RESERVATIONS_RECOMMENDED

RESERVATIONS_POSSIBLE

RESERVATIONS_POSSIBLE_ONLY_IN_FIRST_CLASS

RESERVATIONS_POSSIBLE_ONLY_IN_SECOND_CLASS

Example: RESERVATIONS_COMPULSORY

maximumNumberToReserve

integer · int32

Maximum amount to reserve.

minimumNumberToReserve

integer · int32

Minimum amount to reserve.

compatibleWithVersionRef

string

Compatible with version.

mustReserveWholeCompartment

boolean

Must reserve whole compartment

Reverting

id

string · minLength: 1 · required

Id.

Example: NSB:Reverting:SelfService

status

string · enum · readOnly · required

Reverting status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · required

Reverting version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: Reverting

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Prices in different currencies for the reverting rule.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References for associated fare tables.

allowedAfterControl

boolean

Specifies if revert is allowed after control.

Example: true

Default: false

maximumTimeAfterUse

string

Maximum time after use Represented as a string formatted according to ISO-8601

Example: PT1H

minimumTimeAfterUse

string

Minimum time after use. Represented as a string formatted according to ISO-8601

Example: PT1H

typeOfUsageParameter

string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

VersionOfObjectRef

Fare frame ref.

RoundTrip

A RoundTrip

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:RoundTrip:Child

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

RoundTrip version.

Example: NSB:Version:V1

shortTrip

boolean · required

Short trip

Example: true

isRequired

boolean · required

Is required.

nameOfClass

string · required

Name of class.

Example: RoundTrip

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

doubleSingleFare

boolean · required

Double single fare

Example: true

TextInLanguage[]

RoundTrip Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices for the round trip.

required

boolean

tripType

string · enum

Type of round trip

Enum values:

SINGLE

RETURN

RETURN_ONLY

MULTIPLE

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the round trip.

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

Validity conditions for the round trip.

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

SetString

empty

boolean

traversableAgain

boolean

CellInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:Cell:5zoneAdult

TextInLanguage[] · required

Name.

FarePriceInsert · required

VersionOfObjectRef · required

Fare frame ref.

version

string

Description.

Fare frame ref.

Fare frame ref.

References to for example geographical interval and UserProfile

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

Exchanging

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Exchanging:MiniFlex

status

string · enum · required

Exchanging status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

nameOfClass

string · required

Name of class.

Example: Exchanging

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

hasFee

boolean

Has fee.

FarePrice[]

Prices in different currencies for the exchanging rule.

allowed

string · enum

Allowed.

Enum values:

NONE

PARTIAL

FULL

Example: FULL

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Exchanging version.

Example: NSB:Version:V1

resellWhen

string · enum

Event marking when the exchangeable status of the ticket changes.

Enum values:

NEVER

BEFORE_START_OF_VALIDITY_PERIOD

AFTER_START_OF_VALIDITY_PERIOD

AFTER_END_OF_VALIDITY_PERIOD

BEFORE_FIRST_USE

AFTER_FIRST_USE

BEFORE_VALIDATION

AFTER_VALIDATION

Example: NEVER

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

refundBasis

string · enum

Basis on which refund is made. See allowed values below.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

toFareClass

string · enum

Fare class to which can be exchanged.

Enum values:

FIRST_CLASS

SECOND_CLASS

THIRD_CLASS

ECONOMY_CLASS

BUSINESS_CLASS

TURISTA

PREFERENTE

STANDARD_CLASS

LimitingRule

A LimitingRule

VersionOfObjectRef[]

References for associated fare tables.

canChangeClass

boolean

Whether user can change class.

exchangeableTo

string · enum

Type of exchange allowed.

Enum values:

ANY_PRODUCT

SAME_PRODUCT_SAME_DAY

SAME_PRODUCT_ANY_DAY

UPGRADE_TO_STANDARD_FARE

SPECIFIED_PRODUCTS

VersionOfObjectRef

Fare frame ref.

specifiedProducts

string[]

Reference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'

unusedTicketsOnly

boolean

Unused tickets only.

derivedFromVersionRef

string

Derived from version.

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

compatibleWithVersionRef

string

Compatible with version.

exchangeableFromDuration

string

Duration to start of period before (negative) or after (positive) the trigger point resellWhen (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) or that ticket may be exchanged or refunded.

Example: PT24H

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

numberOfExchangesAllowed

integer · int32

Number of times a ticket may be exchanged.

exchangeableUntilDuration

string

Duration to end of period before (negative) or after ( positive) the trigger point (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) that ticket may be exchanged or refunded.

Example: PT24H

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

CappingRule

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:CappingRule:EnkeltbillettTil24Timer

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: CappingRule

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

activeComparisonOperatorVariant

string · required

Indicates whether a gpa belongs to A or E gpa implementation.

Example: A

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Prices for the fare.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

cappingPeriod

string · enum

Period over which capping applies.

Enum values:

DAY

WEEK

MONTH

Example: DAY

VersionOfObjectRef[]

Reference to fare table.

ValidityCondition[]

Validity conditions.

VersionOfObjectRef

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

VersionOfObjectRef

Fare frame ref.

GenericParameterAssignment[]

Access Right Parameter assignments.

FareDayType

The FareDayType describe during which the assignment applies

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FareDayType:2HoursValidPlus1

TextInLanguage[] · required

Name of fare day type

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

TextInLanguage[] · required

Description of fare day type

nameOfClass

string · readOnly · required

Name of class.

Example: FareDayType

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

dayLength

string

Day length. Represented as a string formatted according to ISO-8601

Example: PT04H

PropertyOfDay[]

Properties of day

earliestTime

string

Earliest time.

Example: 11:11:11

VersionOfObjectRef[]

Time band references.

durationAfterPropertiesOfDay

string

Duration after properties of day. Represented as a string formatted according to ISO-8601

Example: PT7H

durationBeforePropertiesOfDay

string

Duration before properties of day. Represented as a string formatted according to ISO-8601

Example: PT24H

FareProduct

A FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

SalesPackage changed datetime.

created

string · required

SalesPackage create datetime.

nameOfClass

string · required

Name of class.

Example: PreassignedFareProduct

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

ValidityCondition[] · required

ValidityCondition.

AccessRightInProduct[] · required

AccessRightsInProduct.

GenericParameterAssignment[] · required

AccessRightParameterAssignments.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

privateCode

string

PrivateCode.

organisation

string

Organisation who own the product.

VersionOfObjectRef[]

FareTableRef.

organisationId

string

Organisation related to the fareProduct

VersionOfObjectRef

Fare frame ref.

ConditionSummary

A summary of a condition.

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: ZONE_TO_ZONE_FARE

TypeOfFareProduct

A classification of FARE PRODUCTs.

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

CompatibleWithVersionRef

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active for this SP.

Example: A

FareSection

A Fare section.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:FareSection:TrondheimOslo

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class

Example: FareSection

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

Name

Description

Fare frame ref.

Fare frame ref.

Fare frame ref.

GroupTicket

A GroupTicket

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupTicket:FamilyDiscount

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the group ticket.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: GroupTicket

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

The name of the group ticket represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices for the group ticket.

ticketing

string · enum

The type of way that tickets are issued to the group.

Enum values:

ALL_ON_ONE_TICKET

SEPARATE_TICKETS

TICKET_WITH_COUPONS

OTHER

Example: SEPARATE_TICKETS

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

jointCheckIn

string · enum

jointCheckIn

Enum values:

NONE

ALLOWED

REQUIRED

pricingBasis

string · enum

Price basis

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the group ticket.

VersionOfObjectRef

Fare frame ref.

CompanionProfile[]

Companion Profiles in Group Ticket

groupDiscountBasis

string · enum

groupDiscountBasis

Enum values:

FREE

DISCOUNT_FOR_ALL

DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP

STEP_DISCOUNT

DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS

ValidityCondition[]

Validity conditions for the group ticket.

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string

Derived from version.

maximumNumberOfPersons

integer · int32

maximumNumberOfPersons

minimumNumberOfPersons

integer · int32

minimumNumberOfPersons

compatibleWithVersionRef

string

Compatible with version.

OnboardStay

An OnboardStay

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:OnboardStay:Sleeper

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: OnboardStay

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

duration

string

Duration.

Example: PT24H

fareClass

string · enum

Fareclass.

Enum values:

FIRST_CLASS

SECOND_CLASS

THIRD_CLASS

ECONOMY_CLASS

BUSINESS_CLASS

TURISTA

PREFERENTE

STANDARD_CLASS

Example: FIRST_CLASS

permission

string · enum

BoardingPermissionEnum.

Enum values:

EARLYBOARDINGPOSSIBLEBEFOREDEPARTURE

DELAYEDALIGHTINGPOSSIBLEAFTERARRIVAL

OVERNIGHTSTAYONBOARDALLOWED

Example: EARLYBOARDINGPOSSIBLEBEFOREDEPARTURE

UserProfile

A UserProfile

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:UserProfile:Child

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

UserProfile version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: UserProfile

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

UserProfile Name represented in different languages. Language codes are ISO-639.

maxAge

string

Maximum age.

Example: 16

minAge

string

Minimum age.

Example: 4

FarePrice[]

Fare prices for the user profile.

userType

string · enum

UserType.

Enum values:

ANYONE

ADULT

CHILD

INFANT

ANIMAL

SENIOR

GUIDE_DOG

YOUTH

Example: CHILD

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

organisationId

string · readOnly

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

proofOfIdentity

string · enum

proofOfIdentity.

Enum values:

NONE_REQUIRED

PASSPORT

DRIVERS_LICENCE

IDENTITY_DOCUMENT

CREDIT_CARD

MEMBERSHIP_CARD

STUDENT_CARD

LETTER_WITH_ADDRESS

CompanionProfile[]

Companion Profiles in Group Ticket

baseUserProfileRef

string

The id of the base user profile which this profile is a specialization of.

ValidityCondition[]

Validity conditions for the user profile.

typeOfConcessionRef

string

typeOfConcessionRef.

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

VatRegister

A case class for vat register.

id

string · minLength: 1 · required

Id.

Example: ENT:VatRegister:SomeId

vatRate

string · minLength: 1 · required

The percentage rate for the VAT

Example: 12.0

vatGroup

string · enum · required

VAT group

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

validFrom

string · minLength: 1 · required

The time and date from which the VAT is valid

description

string · minLength: 1 · required

The VAT description

Example: Person transport and tickets in Norway

validTo

string

The time and date to which the VAT is valid

vatCode

string

Code for the VAT, used for accounting

Example: 33

countryCode

string

Country for which the VAT is valid, based on ISO 3166-1 alfa-3

Example: NOR

organisationId

integer · int64

OrganisationId for the organisation who uses this VAT-specification.

arrivalCountryCode

string

Specification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

departureCountryCode

string

Specification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

AreaValidity

Requirements for area validity.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:AreaValidity:RuterSingleTicket

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · readOnly · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: RUT:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: AreaValidity

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

minimumZonesForAreaValidity

integer · int32 · required

Minimum no. of zones for area validity.

Example: 5

groupOfTariffZoneRef

string

Group of tariff zone

Example: ENT:GroupOfTariffZone:abcdef

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

FareTableRef

ref

string

version

string

nameOfRefClass

string

IdAndVersion

Describes the ID and version of an element.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

ID of the element.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version of the element.

LimitingRule

A LimitingRule

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

nameOfClass

string · readOnly · required

Name of class.

Example: LimitingRule

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

TextInLanguage[]

Description.

maximumPrice

string

MaximumPrice.

Example: 164.0

minimumPrice

string

MinimumPrice.

Example: 164.0

canBeCumulative

boolean

CanBeCumulative.

discountAsValue

number · float

DiscountAsValue.

minimumLimitPrice

string

MinimumLimitPrice.

Example: 164.0

discountAsPercentage

number · float

DiscountAsPercentage.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

maximumPriceAsPercentage

number · double

MaximumPriceAsPercentage.

SalesPackage

A SalesPackage response

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:SalesPackage:Ordinary

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

SalesPackage changed datetime.

created

string · required

SalesPackage create datetime.

nameOfClass

string · required

Name of class.

Example: SalesPackage

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References to fare tables.

DistributionAssignment[] · required

Distribution assignments.

GenericParameterAssignment[] · required

Access Right Parameter assignments.

TextInLanguage[]

SalesPackage Name.

FarePrice[]

Fare prices.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

TextInLanguage[]

Description.

LimitingRule

A LimitingRule

VersionOfObjectRef

Fare frame ref.

vatGroupRegister

string · enum

VatGroupRegister is optional. No default value

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

SalesPackageElement[]

Sales package elements.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

CompatibleWithVersionRef

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active for this SP.

Example: A

TariffInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:Tariff:Ordinary

TextInLanguage[] · required

Tariff Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Tariff version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

tariffBasis

string · enum

TariffBasis.

Enum values:

NEW

REVISE

DELETE

Example: NEW

derivedFromVersionRef

string

Derived from version.

returnFareTwiceSingle

boolean

returnFareTwiceSingle

ValidBetween

A ValidBetween

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ValidBetween:2018

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

fromDate

string · required

From Date.

nameOfClass

string · required

Name of class.

Example: ValidBetween

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name of ValidBetween represented in different languages. Language codes are ISO-639.

toDate

string

To Date.

TextInLanguage[]

Description of ValidBetween represented in different languages. Language codes are ISO-639.

organisationId

string

Organisation related to the userProfile

ValidityCondition[]

List of validityConditions.

Accommodation

An Accommodation

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Accommodation:Sleeper

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: Accommodation

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nuisanceFacilities

string[]

List of nuisance facilities

accommodationFacility

string · enum

Accommodation facility.

Enum values:

SLEEPER

SEATING

DOUBLE_SLEEPER

SINGLE_SLEEPER

SPECIAL_SLEEPER

COUCHETTE

SINGLE_COUCHETTE

DOUBLE_COUCHETTE

Example: SLEEPER

ElementUsages

ParameterUsages

VersionOfObjectRef[]

Parameters usages mapped to the requested parameter.

Interchanging

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Interchanging:Trondelag

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: Interchanging

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name.

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

TextInLanguage[]

Description.

derivedFromVersionRef

string

Derived from version.

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

VersionOfObjectRef

Fare frame ref.

compatibleWithVersionRef

string

Compatible with version.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

PenaltyPolicy

A PENALTY POLICY

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:PenaltyPolicy:InspectionFeeYoung

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed

created

string · readOnly · required

Created

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

NameOfClass

Example: PenaltyPolicy

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References for associated fare tables.

TextInLanguage[]

Name.

FarePrice[]

Prices in different currencies for the penalty policy.

TextInLanguage[]

Description.

VersionOfObjectRef

Fare frame ref.

LimitingRule

A LimitingRule

paymentMethod

string

PaymentMethod

Example: CASH

penaltyAction

string

PenaltyAction

Example: FINE

VersionOfObjectRef

Fare frame ref.

penaltyPolicyType

string

PenaltyPolicyType

Example: NO_TICKET

derivedFromVersionRef

string

Derived from version.

typeOfUsageParameterRef

string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

compatibleWithVersionRef

string

CompatibleWithVersionRef

minimumTimeBeforeReentry

string

MinimumTimeBeforeReentry

Example: PT24H

sameStationReentryPolicyType

string

SameStationReentryPolicyType

Example: BLOCKED

ProblemDetail

type

string · uri

title

string

detail

string

status

integer · int32

instance

string · uri

object

PropertyOfDay

The DayType describe during which the assignment applies

name

string · required

Name of property of day

Example: Monday

countryRef

string · readOnly · required

Reference to country for holiday. ISO 3166-1

Example: NO

dayOfYear

string · ##-##

Day of year

Example: 01-25

daysOfWeek

string[]

Days of week

description

string

Description of the property of day

Example: Days family discount is available

monthOfYear

integer · enum · int32

Month of year

Enum values:

1

2

3

4

5

6

7

8

holidayTypes

string[]

Holiday types

ChargingMoment

A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ChargingMoment:Prepaid

status

string · enum · readOnly · required

Charging moment status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Charging moment version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: ChargingMoment

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

ChargingPolicy

A ChargingPolicy response

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ChargingPolicy:Ordinary

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

ChargingPolicy changed datetime.

created

string · readOnly · required

ChargingPolicy create datetime.

nameOfClass

string · readOnly · required

Name of class.

Example: ChargingPolicy

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

ChargingPolicy name in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

TextInLanguage[]

ChargingPolicy description in different languages. Language codes are ISO-639

creditPolicy

string · enum

Travel credit policy enum is optional. No default value

Enum values:

ALLOW_TRAVEL

BLOCK_PAY_AS_YOU_GO_TRAVEL

BLOCK_ALL_TRAVEL

OTHER

billingPolicy

string · enum

TravelBillingPolicy is optional. No default value

Enum values:

BILL_AS_YOU_GO

BILL_ON_THRESHOLD

BILL_AT_FARE_DAY_END

BILL_AT_PERIOD_END

expireAfterPeriod

string

Expire after period. Represented as a string formatted according to ISO-8601

Example: PT1H

paymentGracePeriod

string

Payment grace period. Represented as a string formatted according to ISO-8601

Example: PT1H

typeOfUsageParameter

string

type of UsageParameter.

FrequencyOfUse

Frequency of use

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FrequencyOfUse:Single

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Frequency of use changed datetime.

created

string · date-time · required

Frequency of use created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Frequency of use version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: FrequencyOfUse

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References for associated fare tables.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Prices in different currencies for the refunding rule.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

maximalFrequency

integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency

integer · int32

Minimal frequency given for this frequency of use.

frequencyOfUseType

string · enum

Frequency of use type.

Enum values:

NONE

SINGLE

LIMITED

UNLIMITED

TWICE_A_DAY

Example: SINGLE

JourneyPattern

A Journey Pattern

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:JourneyPattern:TrondheimOslo

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class

Example: FareSection

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name

TextInLanguage[]

Description

FarePointInPattern[]

Fare points in pattern. Versioned child of JourneyPattern

PurchaseWindow

A PurchaseWindow

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:PurchaseWindow:Child

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

PurchaseWindow version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: PurchaseWindow

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

PurchaseWindow Name represented in different languages. Language codes are ISO-639.

latestTime

string

Latest time to purchase.

Example: 23:59:59.999999999

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

LimitingRule

A LimitingRule

purchaseWhen

string · enum

When to purchase.

Enum values:

TIME_OF_TRAVEL_ONLY

DAY_OF_TRAVEL_ONLY

ADVANCE_ONLY

UNTIL_PREVIOUS_DAY

ADVANCE_AND_DAY_OF_TRAVEL

OTHER

Example: ADVANCE_AND_DAY_OF_TRAVEL

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

maxmumPeriodBeforeDeparture

string

Maximum period before departure.

Example: 23:59:59.999999999

minimumPeriodBeforeDeparture

string

Minimum period before departure.

Example: 01:59:59.999999999

RoundingInsert

Rounding.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Rounding:Ordinary

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Rounding version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

roundingMethod

string · enum · required

Type of rounding.

Enum values:

NONE

DOWN

UP

SPLIT

STEP_TABLE

FIVE

NINE

TEN

TextInLanguage[]

Name.

TextInLanguage[]

Description.

roundingModulus

number · double

Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.

SecurityPolicy

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:SecurityPolicy:HighValueProduct

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed

created

string · readOnly · required

Created

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

NameOfClass

Example: SecurityPolicy

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

minimumAccountSecurityLevel

integer · int32 · required

Required (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.

TextInLanguage[]

Name.

TextInLanguage[]

Description.

VersionOfObjectRef

Fare frame ref.

TextInLanguage

Text in a specific language.

lang

string · minLength: 1 · required

Language code.

Example: nob

value

string · minLength: 1 · required

The text.

FarePriceInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FarePrice:1005TEN

TextInLanguage[] · required

Name.

VersionOfObjectRef · required

Fare frame ref.

amount

string

Amount.

Example: 164.0

ranking

integer · int32

Ranking.

Example: 1

version

string

currency

string

Currency.

Example: NOK

isAllowed

boolean

isAllowed.

Example: true

VersionOfObjectRef

Fare frame ref.

LimitingRule

A LimitingRule

canBeCumulative

boolean

canBeCumulative.

Example: true

vatRegisterGroup

string · enum

vatRegisterGroup.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

derivedFromVersionRef

string

Derived from version.

discountPercentageUsed

integer · int32

discountPercentageUsed.

Example: 5

compatibleWithVersionRef

string

Compatible with version.

FarePriceUpdate

amount

number · double

Amount in the currency selected at create operation

Example: 16.5

discountPercentageUsed

integer · int32

Discount in percentageUsed

Example: 40

FareQuotaFactor

A FareQuotaFactor

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:FareQuotaFactor:SomeFareQuota4

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

FareQuotaFactor version. Versioned child of FSE,trying to set other versions will be ignored

Example: ENT:Version:SomeVersion4

nameOfClass

string · readOnly · required

Name of class

Example: FareQuotaFactor

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

value

string

The value of fare quota factor.

FarePrice[]

Fare prices for the fare quota factor.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

numberOfUnits

integer · int32

The number of units.

ValidityCondition[]

Gives a sequence of conditions for validity.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

FareTableInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FareTable:Ordinary

TextInLanguage[] · required

Name.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

CellInsert[]

Cell

FarePriceInsert[]

FarePrice.

endDate

string · date

EndDate.

startDate

string · date

StartDate.

VersionOfObjectRef

Fare frame ref.

TextInLanguage[]

Description.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

MapStringObject

empty

boolean

traversableAgain

boolean

RefundingInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:Refunding:SeatUpgrade

TextInLanguage[] · required

Name represented in different languages. Language codes are ISO-639.

allowed

string · enum · required

Allowed.

Enum values:

NONE

PARTIAL

FULL

Example: FULL

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

UsageValidityPeriod version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

hasFee

boolean

Has fee.

FarePriceInsert[]

Prices in different currencies for the refunding rule.

refundType

string · enum

Refund type.

Enum values:

UNUSED

DELAY

CANCELLATION

PARTIAL_JOURNEY

OTHER

Example: UNUSED

resellWhen

string · enum

Event marking when the refundable status of the ticket changes.

Enum values:

NEVER

BEFORE_START_OF_VALIDITY_PERIOD

AFTER_START_OF_VALIDITY_PERIOD

AFTER_END_OF_VALIDITY_PERIOD

BEFORE_FIRST_USE

AFTER_FIRST_USE

BEFORE_VALIDATION

AFTER_VALIDATION,AFTER_PURCHASE

Example: NEVER

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

refundBasis

string · enum

Basis on which refund is made. See allowed values below.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

canChangeClass

boolean

Whether user can change class.

unusedTicketsOnly

boolean

Unused tickets only.

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

exchangeableFromDuration

string

Exchangeable from duration.

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration

string

Exchangeable until duration.

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

ReservingInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Reserving:SeatAsAccommodationReserving

TextInLanguage[] · required

Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Reserving version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

FarePrice[]

Prices for the reserving.

feeBasis

string · enum

Fee basis.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

typeOfUsageParameter

string

Type of usage parameter for the reservation.

Example: NSB:TypeOfUsageParameter:ThroughFareInterchanging

reservationChargeType

string · enum

Type of charge for reservation.

Enum values:

NONE

SINGLE_FEE_FOR_RETURN_TRIP

FEE_FOR_EACH_DIRECTION

FEE_FOR_EACH_LEG

Example: NONE

reservingRequirements

string · enum

Requirements for reservation.

Enum values:

RESERVATIONS_COMPULSORY

RESERVATIONS_COMPULSORY_FOR_GROUPS

RESERVATIONS_COMPULSORY_FOR_FIRST_CLASS

RESERVATIONS_COMPULSORY_FROM_ORIGIN_STATION

RESERVATIONS_RECOMMENDED

RESERVATIONS_POSSIBLE

RESERVATIONS_POSSIBLE_ONLY_IN_FIRST_CLASS

RESERVATIONS_POSSIBLE_ONLY_IN_SECOND_CLASS

Example: RESERVATIONS_COMPULSORY

maximumNumberToReserve

integer · int32

Maximum amount to reserve.

minimumNumberToReserve

integer · int32

Minimum amount to reserve.

mustReserveWholeCompartment

boolean

Must reserve whole compartment

RoundTripInsert

A RoundTrip create request

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:RoundTrip:Child

TextInLanguage[] · required

Round trip Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Round trip version.

Example: NSB:Version:V1

shortTrip

boolean · required

Short trip

Example: true

isRequired

boolean · required

Is required.

VersionOfObjectRef · required

Fare frame ref.

doubleSingleFare

boolean · required

Double single fare

Example: true

FarePrice[]

Fare prices for the round trip.

required

boolean

tripType

string · enum

Type of round trip

Enum values:

SINGLE

RETURN

RETURN_ONLY

MULTIPLE

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the round trip.

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

Validity conditions for the round trip.

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string

Derived from version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

Example: NSB:Version:V1

SteppedDuration

Stepped duration.

stepUnit

string · enum · required

Step unit.

Enum values:

STOPS

STOPS_INCLUDING_PASS_THROUGH_STOPS

SECTIONS

ZONES

NETWORKS

OPERATORS

COUNTRIES

Example: ZONES

initialDuration

string · required

Initial duration. Represented as a string formatted according to ISO-8601

Example: PT1H

subsequentStepsDuration

string · required

Subsequent duration. Represented as a string formatted according to ISO-8601

Example: PT1H

maximumDuration

string

Maximum duration. Represented as a string formatted according to ISO-8601

Example: PT1H

Transferability

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Transferability:NoTransfer

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Transferability version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: Transferability

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Prices in different currencies for the transferability rule.

canTransfer

boolean

Whether ticket can be transferred to someone else.

Example: false

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References for associated fare tables.

hasTransferFee

boolean

Whether there is a charge for making a transfer.

Example: false

maximumNumberOfNamedUsers

integer · int32

Where a product can be used by a limited number of named users, maximum number of users allowed..

v2.SalesPackage

SalesPackage

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:SalesPackage:Ordinary

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class

Example: SalesPackage

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

v2.DistributionAssignment[] · required

Distribution assignments.

GenericParameterAssignment[] · required

Validity Parameter assignments.

TextInLanguage[]

Name

FarePrice[]

Fare prices.

TextInLanguage[]

Description

LimitingRule

A LimitingRule

organisationId

string

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

vatGroupRegister

string · enum

VatGroupRegister is optional. No default value

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

SalesPackageElement[]

Sales package elements.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active for this SP.

Example: A

CompanionProfile

A companion profile

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:CompanionProfile:Adult

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the companion profile.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: CompanionProfile

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

The name of the companion profile represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices for the companion profile.

VersionOfObjectRef

Fare frame ref.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

discountBasis

string · enum

Basis for discount.

Enum values:

NONE

FREE

DISCOUNT

FULLRATE

Example: DISCOUNT

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the companion profile.

userProfileId

string

A user profile defining a category of people eligible to be a companion.

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

Validity conditions for the companion profile.

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string

Derived from version.

VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons

integer · int32

Maximum number of allowed companions.

minimumNumberOfPersons

integer · int32

Minimum number of allowed companions.

compatibleWithVersionRef

string

Compatible with version.

ConditionSummary

A summary of a condition.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ConditionSummary:1005TEN

isRefundable

boolean

Whether the ticket is refundable.

Example: true

isExchangeable

boolean

Whether the ticket is exchangeable.

Example: true

EntitlementGiven

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:EntitlementGiven:TrondelagCustomerCard

TextInLanguage[] · required

The name of the entitlement given represented in different languages. Language codes are ISO-639

FarePrice[] · required

Prices for the entitlement given.

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

TextInLanguage[] · required

Description represented in different languages. Language codes are ISO-639

nameOfClass

string · readOnly · required

Name of class

Example: EntitlementGiven

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

entitlementType

string · enum · required

Entitlement type

Enum values:

USE

PURCHASE

PURCHASE_AT_DISCOUNT

NONE

EntitlementConstraint · readOnly

Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.

VersionOfObjectRef

Fare frame ref.

minimumQualificationPeriod

string

Minimum qualification period

Example: 01:59:59.999999999

ExchangingInsert

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Exchanging:MiniFlex

TextInLanguage[] · required

Name represented in different languages. Language codes are ISO-639.

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required

UsageValidityPeriod version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

hasFee

boolean

Has fee.

FarePriceInsert[]

Fare prices.

allowed

string · enum

Allowed.

Enum values:

NONE

PARTIAL

FULL

Example: FULL

resellWhen

string · enum

Event marking when the exchangeable status of the ticket changes.

Enum values:

NEVER

BEFORE_START_OF_VALIDITY_PERIOD

AFTER_START_OF_VALIDITY_PERIOD

AFTER_END_OF_VALIDITY_PERIOD

BEFORE_FIRST_USE

AFTER_FIRST_USE

BEFORE_VALIDATION

AFTER_VALIDATION,AFTER_PURCHASE

Example: NEVER

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

refundBasis

string · enum

Basis on which refund is made. See allowed values below.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

toFareClass

string · enum

Fare class to which can be exchanged.

Enum values:

FIRST_CLASS

SECOND_CLASS

THIRD_CLASS

ECONOMY_CLASS

BUSINESS_CLASS

TURISTA

PREFERENTE

STANDARD_CLASS

canChangeClass

boolean

Whether user can change class.

exchangeableTo

string · enum

Type of exchange allowed.

Enum values:

ANY_PRODUCT

SAME_PRODUCT_SAME_DAY

SAME_PRODUCT_ANY_DAY

UPGRADE_TO_STANDARD_FARE

SPECIFIED_PRODUCTS

specifiedProducts

string

Reference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'.

unusedTicketsOnly

boolean

Unused tickets only.

derivedFromVersionRef

string

Derived from version.

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

compatibleWithVersionRef

string

Compatible with version.

exchangeableFromDuration

string

Exchangeable from duration.

Example: PT24H

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

numberOfExchangesAllowed

integer · int32

Number of times a ticket may be exchanged.

exchangeableUntilDuration

string

Exchangeable until duration.

Example: PT24H

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

FulfilmentMethod

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FulfilmentMethod:TicketOffice

TextInLanguage[] · required

The name of the fulfilment method represented in different languages. Language codes are ISO-639

FarePrice[] · required

Prices for the fulfilment method.

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

TextInLanguage[] · required

Description represented in different languages. Language codes are ISO-639

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

Reference to TYPEs OF TRAVEL DOCUMENT allowed by method.

nameOfClass

string · readOnly

Name of class.

Example: FulfilmentMethod

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

requiresCard

boolean

Whether collecting ticket requires credit card used to purchase.

fulfilmentMethodType

string · enum

Type of fulfilment method.

Enum values:

TICKET_OFFICE

TICKET_MACHINE

CONDUCTOR

AGENT

POST

SELFPRINT

SMS

TOP_UP_DEVICE

requiresBookingReference

boolean

Whether collecting ticket requires booking reference.

GroupOfTimeBands

A GroupOfTimeband describe during which the assignments applies

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

Timeband[] · required

Members.

nameOfClass

string · required

Name of class.

Example: FareStructureElement

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

ValidityCondition[] · required

ValidityConditions sequence.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

LuggageAllowance

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:LuggageAllowance:Bicycle

TextInLanguage[] · required

The name of the luggage allowance represented in different languages. Language codes are ISO-639

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

TextInLanguage[] · required

Description represented in different languages. Language codes are ISO-639

nameOfClass

string · readOnly · required

Name of class

Example: LuggageAllowance

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

FarePrice[]

Prices for the luggage allowance.

baggageType

string · enum

Baggage Type

Enum values:

HANDBAG

HAND_LUGGAGE

SMALL_SUITCASE

SUITCASE

TRUNK

OVERSIZE_ITEM

BICYCLE

SPORTING_EQUIPMENT

baggageUseType

string · enum

Baggage Use Type

Enum values:

CARRY_ON

CHECK_IN

OVERSIZE_CHECK_IN

organisationId

string

Organisation related to the userProfile

luggageAllowanceType

string · enum

Luggage Allowance Type

Enum values:

NONE

UNLIMITED

SINGLE

LIMITED

luggageChargingBasis

string · enum

Luggage Charging Basis

Enum values:

FREE

CHARGED_BY_ITEM

CHARGED_BY_WEIGHT

OTHER

PeriodTicketInfo

PeriodTicket with userprofiles and usage validity periods

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:PreassignedFareProduct:30Days

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

VersionOfObjectRef[]

Limitations as UsageParameters.

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

organisation

string

Organisation who own the product.

TypeOfConcession

A TypeOfConcession

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfConcession:Student

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

TypeOfConcession version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: TypeOfConcession

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

compatibleWithVersionRef

string · required

Compatible with version.

TextInLanguage[]

TypeOfConcession name represented in different languages. Language codes are ISO-639.

infolink

string

An URL to more info about the type of concession

TextInLanguage[]

TypeOfConcession description represented in different languages. Language codes are ISO-639.

privateCode

string

A code to support interoperability with legacy systems

organisationId

string

Organisation related to the userProfile

alternativeNames

string

Alternative names for the type of concession

derivedFromVersionRef

string

Derived from version.

ValidableElement

A ValidationElement

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ValidableElement:Ordinary

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Validable element version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: ValidableElement

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References for associated fare table.

GenericParameterAssignment[] · required

The references to access right parameter assignments.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

AreaValidity

Requirements for area validity.

organisationId

string

Organisation related to the userProfile

pricingRuleRef

string

Pricing rule reference.

Example: unused

ValidityCondition[]

Gives a sequence of conditions for validity.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

VersionOfObjectRef[]

The reference to the fare divided into a sequence.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

FareStructureElementInSequence[]

The fare structure elements in sequence

CappingRuleInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:CappingRule:EnkeltbillettTil24Timer

TextInLanguage[] · required

UserProfile Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

FareTableRef.

activeComparisonOperatorVariant

string · required

Indicates whether a gpa belongs to A or E gpa implementation.

Example: A

VersionOfObjectRef[] · required

Access Right Parameter assignment references.

FarePrice[]

Fare prices.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

cappingPeriod

string · enum

Period over which capping applies.

Enum values:

DAY

WEEK

MONTH

Example: DAY

VersionOfObjectRef

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

VersionOfObjectRef

Fare frame ref.

GroupTicketInsert

A group ticket create request

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupTicket:FamilyDiscount

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the group ticket.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

The name of the group ticket represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices for the group ticket.

ticketing

string · enum

The type of way that tickets are issued to the group.

Enum values:

ALL_ON_ONE_TICKET

SEPARATE_TICKETS

TICKET_WITH_COUPONS

OTHER

Example: SEPARATE_TICKETS

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

jointCheckIn

string · enum

jointCheckIn

Enum values:

NONE

ALLOWED

REQUIRED

pricingBasis

string · enum

Price basis

Enum values:

PER_OFFER

PER_PERSON

CompanionProfile[]

Companion Profiles in Group Ticket

groupDiscountBasis

string · enum

groupDiscountBasis

Enum values:

FREE

DISCOUNT_FOR_ALL

DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP

STEP_DISCOUNT

DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string

Derived from version.

maximumNumberOfPersons

integer · int32

maximumNumberOfPersons

minimumNumberOfPersons

integer · int32

minimumNumberOfPersons

compatibleWithVersionRef

string

Compatible with version.

PricingRuleEntity

id

string

ListTextInLanguage

version

string

ListTextInLanguage

VersionOfObjectRef

Fare frame ref.

SaleDiscountRight

A Sale Discount Right response

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

FarePrice[] · required

Prices for the sdr.

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

SalesPackage changed datetime.

created

string · readOnly · required

SalesPackage create datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: PreassignedFareProduct

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

organisation

string · required

Organisation who own the product.

ValidityCondition[] · required

ValidityCondition.

AccessRightInProduct[] · required

AccessRightsInProduct.

GenericParameterAssignment[] · required

AccessRightParameterAssignments.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

privateCode

string

PrivateCode.

VersionOfObjectRef[]

FareTableRef.

organisationId

string

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

ConditionSummary

A summary of a condition.

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: ZONE_TO_ZONE_FARE

TypeOfFareProduct

A classification of FARE PRODUCTs.

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

VersionOfObjectRef

Fare frame ref.

derivedFromVersionRef

string · readOnly

Derived from version.

validationRequirements

string

A set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Example: ["IDENTIFIABLE_CUSTOMER"]

compatibleWithVersionRef

string · readOnly

CompatibleWithVersionRef

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

SupplementProduct

A SUPPLEMENT PRODUCT consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT and FARE PRODUCT

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:SupplementProduct:BicycleReserving

status

string · enum · required

Supplement product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Supplement product version.

Example: NSB:Version:V1

vatGroup

string · enum · required

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

nameOfClass

string · required

Name of class.

Example: SupplementProduct

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

organisation

string · required

Organisation.

VersionOfObjectRef[] · required

Reference to information about the fare.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

fareProductRef.

ValidityCondition[] · required

validityConditions.

AccessRightInProduct[] · required

accessRightParameterAssignments.

GenericParameterAssignment[] · required

accessRightParameterAssignments.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

operatorRef

string

The reference to the operator.

Example: RUT:Authority:RUT

privateCode

string

Privat code.

organisationId

string

Organisation related to the userProfile

ConditionSummary

A summary of a condition.

fareStructureType

string · enum

FareStructureType

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: POINT_TO_POINT_FARE

TypeOfFareProduct

A classification of FARE PRODUCTs.

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

derivedFromVersionRef

string

Derived from version.

supplementProductType

string · enum

The type of supplement product for which the supplement product belongs to.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

compatibleWithVersionRef

string

Compatible with version.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

TypeOfFareProduct

A classification of FARE PRODUCTs.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfFareProduct:Ordinary

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Type of fare product version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: TypeOfFareProduct

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

status

string · enum · readOnly

Type of fare product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

UserProfileInsert

A UserProfile create request

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:UserProfile:Child

TextInLanguage[] · required

UserProfile Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

UserProfile version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

proofOfIdentity

string · enum · required

proofOfIdentity.

Enum values:

NONE_REQUIRED

PASSPORT

DRIVERS_LICENCE

IDENTITY_DOCUMENT

CREDIT_CARD

MEMBERSHIP_CARD

STUDENT_CARD

LETTER_WITH_ADDRESS

maxAge

integer · int32

Maximum age.

Example: 16

minAge

integer · int32

Minimum age.

Example: 4

FarePrice[]

Fare prices for the user profile.

userType

string · enum

UserType.

Enum values:

ANYONE

ADULT

CHILD

INFANT

ANIMAL

SENIOR

GUIDE_DOG

YOUTH

Example: CHILD

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

VersionOfObjectRef

Fare frame ref.

CompanionProfileInject[]

Companion profiles describing users who may travel with user.

baseUserProfileRef

string

The id of the base user profile which this profile is a specialization of.

ValidityCondition[]

Validity conditions for the user profile.

typeOfConcessionRef

string

typeOfConcessionRef.

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string

Derived from version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

Example: NSB:Version:V1

ValidityCondition

A condition of the validity of the priceable object

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ValidBetween:2018

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: ValidBetween

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

toDate

string

To Date.

fromDate

string

From Date.

EntitlementProduct

An ENTITLEMENT PRODUCT response.

id

string · required

Id.

Example: RUT:EntitlementProduct:PersonalTicket

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

nameOfClass

string · required

Name of class.

Example: EntitlementProduct

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

ValidityCondition[] · required

ValidityCondition.

TextInLanguage[]

Name.

version

string

Version.

Example: NSB:Version:V1

TextInLanguage[]

Description.

privateCode

string

PrivateCode.

organisation

string

Organisation who own the product.

VersionOfObjectRef[]

FareTableRef.

VersionOfObjectRef

Fare frame ref.

TypeOfFareProduct

A classification of FARE PRODUCTs.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

FarePointInPattern

A Fare Point In Pattern

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:FarePointInPattern:TrondheimOslo

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · readOnly · required

Version, will be a versioned child of journey pattern

Example: NSB:Version:V1

pointRef

string · required

Point Ref

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

orderOfElement

integer · int32 · required

Order of element

VersionOfObjectRef · required

Fare frame ref.

changed

string · readOnly

Changed datetime

created

string · readOnly

Created datetime

nameOfClass

string · readOnly

Name of class

Example: FarePointInPattern

ValidityCondition[] · readOnly

Validity Conditions.

ListTextInLanguage

empty

boolean

traversableAgain

boolean

NameAndDescription

TextInLanguage[] · required

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[] · required

Description represented in different languages. Language codes are ISO-639.

SalesPackageInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:UserProfile:Child

TextInLanguage[] · required

UserProfile Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

UserProfile version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

DistributionAssignmentInsert[] · required

Distribution assignments.

VersionOfObjectRef[] · required

AccessRightParameterAssignments.

FarePriceInsert[]

Fare prices.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References to fare tables.

vatGroupRegister

string · enum

VatGroupRegister is optional. No default

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

SalesPackageElementInsert[]

Sales package elements.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

ServiceFacilitySet

A ServiceFacilitySet

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:ServiceFacilitySet:Ordinary

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class

Example: ServiceFacilitySet

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name

TextInLanguage[]

Description

OnboardStay

An OnboardStay

Accommodation

An Accommodation

ValidBetweenInsert

A ValidBetween create request

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ValidBetween:2018

fromDate

string · required

From Date.

Example: 2017-07-21T17:32:28Z

VersionOfObjectRef · required

Fare frame ref.

toDate

string

To Date.

Example: 2017-07-21T17:32:28Z

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

ValidityCondition[]

List of validityConditions.

VersionOfObjectRef

Fare frame ref.

ref

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The netex id reference to the object.

version

string · required

Version.

nameOfClass

string · minLength: 1 · required

Name of class.

CappedDiscountRight

A Capped Discount Right response

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:CappedDiscountRight:BestePrisFylket

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: CappedDiscountRight

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

vatGroupRegister

string · enum · required

VatGroupRegister.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

ValidityCondition[] · required

ValidityCondition.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Prices.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

privateCode

string

PrivateCode.

CappingRule[]

Capping rules.

organisation

string

Organisation who own the product.

VersionOfObjectRef[]

FareTableRef.

organisationId

string

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

ConditionSummary

A summary of a condition.

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: ZONE_TO_ZONE_FARE

TypeOfFareProduct

A classification of FARE PRODUCTs.

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

AccessRightInProduct[]

AccessRightsInProduct.

derivedFromVersionRef

string

Derived from version.

validationRequirements

string

An optional set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Example: ["IDENTIFIABLE_CUSTOMER"]

compatibleWithVersionRef

string

CompatibleWithVersionRef

GenericParameterAssignment[]

AccessRightParameterAssignments.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

EntitlementRequired

Entitlement Required.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: ENT:EntitlementRequired:SingleTicket

TextInLanguage[] · required

The name of the entitlement required represented in different languages. Language codes are ISO-639

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: ENT:Version:ER-SingleTicket-1

TextInLanguage[] · required

Description represented in different languages. Language codes are ISO-639

nameOfClass

string · readOnly · required

Name of class

Example: EntitlementRequired

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

FarePrice[]

Fare prices for the entitlement required.

organisationId

string

Organisation related to the userProfile

ValidityCondition[]

Pricing rule reference.

typeOfUsageParameter

string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

EntitlementConstraint · readOnly

Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.

serviceAccessRightNetexId

string

Reference to the serviceAccessRight required.

Example: ENT:PreassignedFareProduct:SingleTicket

minimumQualificationPeriod

string

Minimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601

Example: PT1H

InterchangingInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Interchanging:Trondelag

TextInLanguage[] · required

Name.

VersionOfObjectRef · required

Fare frame ref.

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

TextInLanguage[]

Description.

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

VersionOfObjectRef

Fare frame ref.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

MininmalVersionInfo

id

string · readOnly · required

Id.

Example: NSB:ElementTypeMetadata:Test

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · readOnly · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: ElementTypeMetadata

TextInLanguage[] · readOnly

Name represented in different languages. Language codes are ISO-639.

endDate

string · date-time · readOnly

EndDate

startDate

string · date-time · readOnly

StartDate

PricingParameterSet

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:PricingParameterSet:123abc

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: TypeOfUsageParameter

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

compatibleWithVersionRef

string · required

Compatible with version.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

PricingRuleEntity[]

Different rules that is common for the operator

derivedFromVersionRef

string

Derived from version.

SalesPackageElement

A SalesPackageElement

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:SalesPackageElement:Ordinary

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: SalesPackageElement

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

References to fare tables.

Name.

Description.

A LimitingRule

Fare frame ref.

Fare frame ref.

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

VersionOfObjectRef

Fare frame ref.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

SeqStatusFilterEnum

empty

boolean

traversableAgain

boolean

UVPForNumberOfZones

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:UVPForNumberOfZones:example

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

nameOfClass

string · required

Name of class.

Example: UVPForNumberOfZones

VersionOfObjectRef · required

Fare frame ref.

numberOfZones

integer · int64 · required

Number of zones.

Example: 3

usageValidityPeriodId

string · required

Reference to usage validity period.

Example: NSB:UsageValidityPeriod:Child

zoneRange

string

Zone range.

Example: 4:9

UsageValidityPeriod

A UsageValidityPeriod response

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:UsageValidityPeriod:Child

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

UsageValidityPeriod version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: UsageValidityPeriod

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

FareTableRef[] · required

References to FareTable.

TextInLanguage[]

UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.

usageEnd

string · enum

Usage end.

Enum values:

STANDARD_DURATION

END_OF_CALENDAR_PERIOD

END_OF_RIDE

END_OF_TRIP

END_OF_FARE_DAY

END_OF_FARE_PERIOD

PRODUCT_EXPIRY

PROFILE_EXPIRY

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

usageTrigger

string · enum

Usage trigger.

Enum values:

START_OF_PERIOD

START_OUT_BOUND_RIDE

END_OUT_BOUND_RIDE

START_RETURN_RIDE

PURCHASE

SPECIFIED_START_DATE

FULFILMENT

DAY_OFFSET_BEFORE_CALENDAR_PERIOD

activationMeans

string[]

Activation Means. Describes how a product can be activated.

LimitingRule

A LimitingRule

SteppedDuration

Stepped duration.

standardDuration

string

Standard duration. Represented as a string formatted according to ISO-8601

Example: PT1H

usageValidityType

string · enum

Usage validity type.

Enum values:

SINGLE_RIDE

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

WEEKEND_PASS

MONTHLY_PASS

usageValidityTypes

string[]

Usage validity type list.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

usageStartConstraintType

string · enum

Usage start constraint.

Enum values:

VARIABLE

FIXED

FIXED_WINDOW

AccessRightInProduct

A VALIDABLE ELEMENT as a part of a PRE-ASSIGNED FARE PRODUCT, including its possible order in the set of all VALIDABLE ELEMENTs grouped together to define the access right assigned to that PRE-ASSIGNED FARE PRODUCT.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:AccessRightInProduct:Ordinary

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Access right in product version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

status

string · enum · readOnly

Access right in product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly

Changed datetime.

created

string · readOnly

Created datetime.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

nameOfClass

string · readOnly

Name of class.

Example: Refunding

accessNumber

integer · int32

The actual access number

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

maximumAccess

integer · int32

Maximum number of times use of this element may occur in a given trip

minimumAccess

integer · int32

Minimum number of times use of this element must occur in a given trip

orderOfElement

integer · int32

The actual order in the sequence

isLastInSequence

boolean

Whether element is last in sequence

isFirstInSequence

boolean

Whether element is first in sequence

limitedAccessNumber

integer · int32

Flag indicating whether this rights gives an unlimited number of accesses or not

accessNumberIsLimited

boolean

Flag indicating if access number is limited

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

ChargingMomentInsert

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ChargingMoment:Prepaid

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required

Charging moment version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

FareStructureElement

A element describing the response structure of the fare

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FareStructureElement:TENInterval

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

nameOfClass

string · required

Name of class.

Example: FareStructureElement

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[] · required

fare table reference

ValidityCondition[] · required

ValidityConditions sequence.

GenericParameterAssignment[] · required

Access Right Parameter assignments.

VersionOfObjectRef[] · required

geographical interval sequence

VersionOfObjectRef[] · required

quality structure factor refs

VersionOfObjectRef[] · required

geographical structure factor refs

TextInLanguage[]

Name.

FarePrice[]

Fare prices.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

TextInLanguage[]

Description.

tariffBasis

string · enum

Tariff basis.

Enum values:

FLAT

DISTANCE

UNIT_SECTION

ZONE

ZONE_TO_ZONE

POINT_TO_POINT

ROUTE

TOUR

Example: DISTANCE

LimitingRule

A LimitingRule

organisationId

string · readOnly

Organisation related to the userProfile

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

FareTablePageWrapper

FareTable[] · readOnly · required

Fare Tables for the given page

totalNumberOfItems

integer · int32 · required

Total number of items.

Example: 369

totalNumberOfPages

integer · int32 · readOnly · required

Number of pages needed to traverse all items.

Example: 15

requestedPageNumber

integer · int32 · required

Number of the requested page. In case state is lost

Example: 369

FrequencyOfUseInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FrequencyOfUse:Single

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Frequency of use version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePriceInsert[]

Prices in different currencies for the frequency of use.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References for associated fare tables.

maximalFrequency

integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency

integer · int32

Minimal frequency given for this frequency of use.

frequencyOfUseType

string · enum

Frequency of use type.

Enum values:

NONE

SINGLE

LIMITED

UNLIMITED

TWICE_A_DAY

Example: SINGLE

GeographicalInterval

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GeographicalInterval:1364TEN

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

FarePrice[]

Prices for the fare.

nameOfClass

string · readOnly

Name of class.

Example: GeographicalInterval

intervalType

string · enum

intervalType.

Enum values:

STOP

TARIFF_ZONE

DISTANCE

COUPON

OTHER

LimitingRule

A LimitingRule

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef[]

Reference to fare table.

numberOfUnits

number · double

numberOfUnits.

ValidityCondition[]

validityConditions.

endGeographicalValue

integer · int64

endGeographicalValue.

derivedFromVersionRef

string

Derived from version.

startGeographicalValue

integer · int64

startGeographicalValue.

compatibleWithVersionRef

string

Compatible with version.

ProductTreeExplained

Schema for presenting explained messages for failed product trees

id

string · minLength: 1 · readOnly · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id for root component/element

Example: NSB:SalesPackage:SomeSalesPackage

TextInLanguage[] · required

Name of the root element represented in different languages. Language codes are ISO-639

version

string · minLength: 1 · readOnly · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version for root component/element

Example: NSB:Version:V1

severity

string · enum · readOnly · required

Severity of the explained event. 'error' drops the tree; 'warning' is published alongside the tree

Enum values:

error

warning

Example: error

TextInLanguage[] · required

Description of the root element represented in different languages. Language codes are ISO-639

TextInLanguage[] · required

Name of the explained element represented in different languages. Language codes are ISO-639

TextInLanguage[] · required

Description of the explained element represented in different languages. Language codes are ISO-639

reason

string · readOnly

Reason for failed tree

Example: invalidProductData

SeqExplainedMessageResponse · readOnly

Translated messages explaining the failure

nameOfClass

string · minLength: 1 · readOnly

nameOfClass

Example: SalesPackage

explainedElementId

string · readOnly

The netexId of the explained element

originalErrorMessage

string · readOnly

The original error message thrown

explainedElementVersion

string · readOnly

The version of the explained element

explainedElementNameOfClass

string · readOnly

The nameOfClass of the explained element

PurchaseWindowInsert

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:PurchaseWindow:90days

TextInLanguage[] · required

PurchaseWindow Name represented in different languages. Language codes are ISO-639.

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required

PurchaseWindow version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

latestTime

string

Latest time.

Example: 23:59:59

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

LimitingRule

A LimitingRule

purchaseWhen

string · enum

When to purchase.

Enum values:

TIME_OF_TRAVEL_ONLY

DAY_OF_TRAVEL_ONLY

ADVANCE_ONLY

UNTIL_PREVIOUS_DAY

ADVANCE_AND_DAY_OF_TRAVEL

OTHER

Example: ADVANCE_AND_DAY_OF_TRAVEL

maxmumPeriodBeforeDeparture

string

Maximum period before departure.

Example: PT2160H

minimumPeriodBeforeDeparture

string

Minimum period before departure.

Example: PT2160H

SeqSaleDiscountRight

empty

boolean

traversableAgain

boolean

TypeOfUsageParameter

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfUsageParameter:abc123

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: TypeOfUsageParameter

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

compatibleWithVersionRef

string · required

Compatible with version.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

derivedFromVersionRef

string

Derived from version.

VersionBatchRetrieve

A case class for versioning.

entityIds

string[] · required

entityIds

Example: ["ENT:PreassignedFareProduct:abc123","ENT:PreassignedFareProduct:123abc"]

v2.SupplementProduct

A Supplement product consisting of one or several validable elements, specific to a charging moment and fare product

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:SupplementProduct:BicycleReserving

status

string · enum · readOnly · required

Supplement product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Supplement product version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: SupplementProduct

operatorRef

string · required

The reference to the operator.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

organisationRef

string · required

The reference to the organisation.

Example: ENT:Authority:ENT

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

privateCode

string

Privat code.

VersionOfObjectRef[]

Reference to information about the fare.

ConditionSummary

A summary of a condition.

vatGroupRegister

string · enum

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

fareStructureType

string · enum

FareStructureType

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: POINT_TO_POINT_FARE

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

ValidityCondition[]

validityConditions.

VersionOfObjectRef

Fare frame ref.

AccessRightInProduct[]

accessRightParameterAssignments.

supplementProductType

string · enum

The type of supplement product for which the supplement product belongs to.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

GenericParameterAssignment[]

accessRightParameterAssignments.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

AvailabilityCondition

An AvailabilityCondition

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:AvailabilityCondition:SomeId

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

toDate

string · required

toDate datetime.

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

AvailabilityCondition version.

Example: ENT:Version:SomeVersion

fromDate

string · required

FromDate datetime.

isAvailable

boolean · required

Is available

nameOfClass

string · readOnly · required

Name of class

Example: AvailabilityCondition

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

available

boolean

VersionOfObjectRef[]

Day Type references.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

Time band references.

organisationId

string

Organisation related to the userProfile

DistanceMatrixElement

A DistanceMatrixElement

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:DistanceMatrixElement:NSR167ToNSR359

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

DistanceMatrixElement version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: DistanceMatrixElement

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices for the user profile.

groupId

integer · int64

Group id.

Example: 4

distance

number · double

Distance.

Example: 16.4

VersionOfObjectRef

Fare frame ref.

isDirect

boolean

Is a direct route.

Example: true

tariffId

integer · int64

Tariff id.

VersionOfObjectRef

Fare frame ref.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

endFareZoneRef

string

End fare zone reference.

inverseAllowed

boolean

Inverse is allowed.

Example: true

VersionOfObjectRef

Fare frame ref.

relativeRanking

integer · int32

Relative ranking.

Example: 2

startFareZoneRef

string

Start fare zone reference.

ValidityCondition[]

Validity conditions for the user profile.

endScheduledStopPointId

string

End scheduled stop point netexId.

startScheduledStopPointId

string

Start scheduled stop point netexId.

EntitlementConstraint

Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.

nameOfClass

string · readOnly · required

Name of class

Example: EntitlementConstraint

userConstraint

string · enum

User constraint

Enum values:

ANYONE

SAME_PERSON

DIFFERENT_PERSON

SPECIFIC

routeConstraint

string · enum

Route constraint

Enum values:

ANY

SAME

OPPOSITE_DIRECTION

DIFFERENT

originConstraint

string · enum

Origin constraint

Enum values:

ANY

SAME

SAME_AS_ORIGIN

SAME_AS_DESTINATION

SAME_AS_ORIGIN_OR_DESTINATION

ANY_STOP_ON_ROUTE

ANY_STOP_IN_ZONE

DIFFERENT

periodConstraint

string · enum

Period constraint

Enum values:

ANY

SAME_PERIOD

WITHIN_SAME_PERIOD

SAME_DAY

SAME_DAY_OF_RETURN

SAME_FARE_DAY

NEXT_DAY

EQUIVALENT_DURATION

specificProfiles

string[]

Specific user profiles which entitlement applies

journeyConstraint

string · enum

Journey constraint

Enum values:

ANY

SAME

SIMILAR

DIFFERENT

operatorConstraint

string · enum

Operator constraint

Enum values:

ANY

SAME

PARTICIPATING

DIFFERENT

directionConstraint

string · enum

Direction constraint

Enum values:

ANY

SAME

OPPOSITE_DIRECTION

DIFFERENT

classOfUseConstraint

string · enum

Class of use constraint

Enum values:

ANY

SAME

SAME_OR_EQUIVALENT

DIFFERENT

tariffZoneConstraint

string · enum

Tariff zone constraint

Enum values:

ANY

SAME

SAME_AS_ORIGIN

SAME_AS_DESTINATION

SAME_AS_ORIGIN_OR_DESTINATION

WITHIN

CONTAINING

EQUIVALENT

destinationConstraint

string · enum

Destination constraint

Enum values:

ANY

SAME

SAME_AS_ORIGIN

SAME_AS_DESTINATION

SAME_AS_ORIGIN_OR_DESTINATION

ANY_STOP_ON_ROUTE

ANY_STOP_IN_ZONE

DIFFERENT

FareScheduledStopPoint[]

Fare scheduled stop points which entitlement applies

typeOfTravelDocumentConstraint

string · enum

Type of travel document constraint

Enum values:

ANY

SAME

SAME_MEDIA

SAME_SMART_CARD

SAME_MOBILE_APP

DIFFERENT

typeOfProductCategoryConstraint

string · enum

Type of product category constraint

Enum values:

ANY

SAME

SAME_OR_EQUIVALENT

DIFFERENT

RefundingAlternatives

Refunding alternatives for an element.

IdAndVersion · required

Describes the ID and version of an element.

Refunding[] · required

Refunding alternatives for this element.

CompanionProfileInject

A companion profile create request

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:CompanionProfile:Adult

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

The version of the companion profile.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

The name of the companion profile represented in different languages. Language codes are ISO-639.

FarePrice[]

Fare prices for the companion profile.

VersionOfObjectRef

Fare frame ref.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

discountBasis

string · enum

Basis for discount.

Enum values:

NONE

FREE

DISCOUNT

FULLRATE

Example: DISCOUNT

userProfileId

string

A user profile defining a category of people eligible to be a companion.

VersionOfObjectRef

Fare frame ref.

typeOfUsageParameter

string

typeOfUsageParameter.

derivedFromVersionRef

string

Derived from version.

VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons

integer · int32

Maximum number of allowed companions.

minimumNumberOfPersons

integer · int32

Minimum number of allowed companions.

compatibleWithVersionRef

string

Compatible with version.

ConditionSummaryInsert

ConditionSummary.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ConditionSummary:1005TEN

isRefundable

boolean

Whether the ticket is refundable.

Example: true

isExchangeable

boolean

Whether the ticket is exchangeable.

Example: true

DistributionAssignment

A distributionAssignment

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:DistributionAssignment:Ordinary

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: DistributionAssignment

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

paymentMethods

string[] · required

Payment methods.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

distributionRights

string · enum · required

Distribution rights.

Enum values:

NONE

SELL

REFUND

EXCHANGE

INFROM

PRIVATE

OTHER

Example: SELL

allDistributionChannelsRef

boolean · required

Flag for distribution in all channels.

TextInLanguage[]

Name.

countryRef

string

Country reference.

TextInLanguage[]

Description.

finalCarrier

boolean

Flag for final carrier.

anyCountryRef

boolean

Flag for allowed in any country.

initialCarrier

boolean

Flag for initial carrier.

transitCarrier

boolean

Flag for transit carrier.

allowedInChannel

boolean

Flag for allowed in channel.

allowedInCountry

boolean

Flag for allowed in country.

mandatoryProduct

boolean

Flag for mandatory product.

ticketingServices

string[]

Ticketing services.

allOrganisationRef

boolean

Flag for all organisations.

VersionOfObjectRef

Fare frame ref.

restrictedToChannel

boolean

Flag for restricted to channel.

topographicPlaceRef

string

Topographical place reference.

requiresRegistration

boolean

Flag for requires registration.

responsibilitySetRef

string

Responsibility set reference.

derivedFromVersionRef

string

Derived from version.

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

distributionChannelType

string · enum

Type of distribution channel.

Enum values:

AT_STOP

ON_BOARD

ONLINE

TELEPHONE

ELECTRONIC_PASS

MOBILE_DEVICE

AGENCY

TOUR_OPERATOR

VersionOfObjectRef

Fare frame ref.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

VersionOfObjectRef

Fare frame ref.

ExchangingAlternatives

Exchanging alternatives for an element.

IdAndVersion · required

Describes the ID and version of an element.

Exchanging[] · required

Exchanging alternatives for this element.

FareScheduledStopPoint

FareScheduledStopPoint, stopPlace and stopPoint Netex Ids should point to same location

stopPlaceNetexId

string · pattern: ^([A-Z]{3}):([A-Za-z…

Stop place Netex Id

stopPointNetexId

string · pattern: ^([A-Z]{3}):([A-Za-z…

Stop point Netex Id

GeneralGroupOfEntities

General Group of Entities.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:GeneralGroupOfEntities:SomeId

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef[] · required

Member refs.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion

nameOfClass

string · readOnly · required

Name of class

Example: GeneralGroupOfEntities

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfMemberClass

string · required

Name of member class

TextInLanguage[]

GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.

organisationId

string

Organisation related to the userProfile

ValidityCondition[] · readOnly

Validity conditions for the general group of entities.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

PreassignedFareProduct

A PREASSIGNED FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

nameOfClass

string · required

Name of class.

Example: PreassignedFareProduct

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

vatGroupRegister

string · enum · required

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

ValidityCondition[] · required

ValidityCondition.

AccessRightInProduct[] · required

AccessRightsInProduct.

GenericParameterAssignment[] · required

AccessRightParameterAssignments.

TextInLanguage[]

Name.

FarePrice[]

Fare prices.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

TextInLanguage[]

Description.

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

privateCode

string

PrivateCode.

productType

string · enum

The type of fare product.

Enum values:

SINGLE_TRIP

TIME_LIMITED_SINGLE_TRIP

PERIOD_PASS

Example: SINGLE_TRIP

organisation

string

Organisation who own the product.

VersionOfObjectRef[]

FareTableRef.

organisationId

string

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

ConditionSummary

A summary of a condition.

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: POINT_TO_POINT_FARE

TypeOfFareProduct

A classification of FARE PRODUCTs.

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

TypeOfConcessionInsert

A TypeOfConcession

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:TypeOfConcession:Student

TextInLanguage[] · required

TypeOfConcession name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

TypeOfConcession version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

infolink

string

An URL to more info about the type of concession

TextInLanguage[]

TypeOfConcession description represented in different languages. Language codes are ISO-639.

privateCode

string

A code to support interoperability with legacy systems

alternativeNames

string

Alternative names for the type of concession

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

ValidableElementInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:ValidableElement:Child

TextInLanguage[] · required

ValidableElement Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

ValidableElement version.

Example: NSB:Version:V1

TextInLanguage[] · required

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef · required

Fare frame ref.

FarePriceInsert[]

Fare prices.

AreaValidity

Requirements for area validity.

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

VersionOfObjectRef[]

The reference to the fare divided into a sequence.

VersionOfObjectRef[]

The references to access right parameter assignments.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

FareStructureElementInSequenceInsert[]

Fare structure elements in sequence

SalesPackagePageWrapper

v2.SalesPackage[] · readOnly · required

SalesPackages for the given page

totalNumberOfItems

integer · int32 · readOnly · required

Total number of items.

Example: 369

totalNumberOfPages

integer · int32 · readOnly · required

Number of pages needed to traverse all items.

Example: 15

requestedPageNumber

integer · int32 · readOnly · required

Number of the requested page. In case state is lost

Example: 13

SupplementProductInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:SupplementProduct:LargeAnimal

TextInLanguage[] · required

Name.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

operatorRef

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

OperatorRef.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

organisation

string · minLength: 1 · required

Organisation.

VersionOfObjectRef · required

Fare frame ref.

FarePriceInsert[]

Fare prices.

TextInLanguage[]

Description.

privateCode

string

PrivateCode.

VersionOfObjectRef[]

FareTableRef.

ConditionSummaryInsert

ConditionSummary.

vatGroupRegister

string · enum

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: ZONE_TO_ZONE_FARE

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

VersionOfObjectRef

Fare frame ref.

AccessRightInProductInsert[]

AccessRightsInProduct.

derivedFromVersionRef

string

Derived from version.

supplementProductType

string · enum

SupplementProductType.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

Example: SEAT_RESERVATION

compatibleWithVersionRef

string

Compatible with version.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

VersionOfObjectRef[]

AccessRightParameterAssignments.

TypeOfFareProductInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfFareProduct:Ordinary

VersionOfObjectRef · required

Fare frame ref.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Type of fare product version.

Example: NSB:Version:V1

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

AmountOfPriceUnitProduct

An Amount Of Price Unit Product response

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:AmountOfPriceUnitProduct:RuterCarnetTicket

amount

integer · int32 · min: 1 · required

Amount. Must be greater than 0.

Example: 10

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

productType

string · enum · required

AmountOfPriceUnitProductType.

Enum values:

TRIP_CARNET

PASS_CARNET

UNIT_COUPON

STORED_VALUE

OTHER

Example: TRIP_CARNET

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

changed

string · readOnly

Changed datetime.

created

string · readOnly

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

nameOfClass

string · readOnly

Name of class.

Example: AmountOfPriceUnitProduct

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

privateCode

string

PrivateCode.

organisation

string

Organisation who own the product.

VersionOfObjectRef[]

FareTableRef.

organisationId

string

Organisation related to the userProfile

VersionOfObjectRef

Fare frame ref.

ConditionSummary

A summary of a condition.

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: ZONE_TO_ZONE_FARE

TypeOfFareProduct

A classification of FARE PRODUCTs.

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

ValidityCondition[] · readOnly

ValidityCondition.

AccessRightInProduct[]

AccessRightsInProduct.

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

CompatibleWithVersionRef

GenericParameterAssignment[] · readOnly

AccessRightParameterAssignments.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

VersionOfObjectRef[] · writeOnly

AccessRightParameterAssignmentRefs.

ScopingValidityParameter

A ScopingValidityParameter

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ScopingValidityParameter:OperatorNSB

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: ScopingValidityParameter

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef · required

Fare frame ref.

lineRef

string

LineRef.

lineType

string · enum

LineType.

Enum values:

LOCAL

URBAN

LONG_DISTANCE

EXPRESS

SEASONAL

REPLACEMENT

FLEXIBLE

CORRIDOR_SERVICE

Example: EXPRESS

placeUse

string · enum

PlaceUse

Enum values:

START_AT

END_AT

VIA

RESTRICT_TO

OTHER

fareClasses

string[]

FareClasses. Enum as string with the following values: FIRST_CLASS, SECOND_CLASS, THIRD_CLASS, ECONOMY_CLASS, BUSINESS_CLASS, TURISTA, PREFERENTE, STANDARD_CLASS, PREMIUM_CLASS, ANY, UNKNOWN

fareZoneRef

string

FareZoneRef.

Example: KOL:FareZone:250

operatorRef

string

Operator referance.

vehicleMode

string · enum

VehicleModeRef.

Enum values:

AIR

BUS

COACH

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

authorityRef

string

AuthorityRef.

Example: NSB:Authority:NSB

facilitySetRef

string

facilitySetRef.

fareSectionRef

string

Fare section ref.

groupOfLinesRef

string

Group of Lines ref.

Example: ENT:GroupOfLines:AllLines

transportSubmode

string · enum

TransportSubmode.

Enum values:

unknown

undefined

internationalFlight

domesticFlight

intercontinentalFlight

domesticScheduledFlight

shuttleFlight

intercontinentalCharterFlight

Example: expressBus

topographicPlaceRef

string

TopographicPlaceRef

derivedFromVersionRef

string

Derived from version.

groupOfTariffZonesRef

string

Group of Tariff Zones ref.

Example: ENT:GroupOfTariffZones:AllZones

scheduledStopPointRef

string

Scheduled stop Point ref.

distributionChannelRef

string

Distribution channel ref.

Example: ENT:DistributionChannel:App

compatibleWithVersionRef

string

CompatibleWithVersionRef.

CappedDiscountRightInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:CappedDiscountRight:BestePrisFylket

TextInLanguage[] · required

Name.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

operatorRef

string · required

OperatorRef.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

organisation

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Organisation.

VersionOfObjectRef · required

Fare frame ref.

FarePriceInsert[]

Prices.

TextInLanguage[]

Description.

privateCode

string

PrivateCode.

CappingRuleInsert[]

Capping rules.

VersionOfObjectRef[]

FareTableRef.

ConditionSummaryInsert

ConditionSummary.

vatGroupRegister

string · enum

VatGroupRegister.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: ZONE_TO_ZONE_FARE

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

VersionOfObjectRef

Fare frame ref.

AccessRightInProductInsert[]

AccessRightsInProduct.

derivedFromVersionRef

string

Derived from version.

validationRequirements

string

A set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Example: ["IDENTIFIABLE_CUSTOMER"]

compatibleWithVersionRef

string

Compatible with version.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

VersionOfObjectRef[]

AccessRightParameterAssignments.

PenaltyPolicyAlternatives

Penalty policy alternatives for an element.

IdAndVersion · required

Describes the ID and version of an element.

PenaltyPolicy[] · required

Penalty policy alternatives for this element.

SalesPackageElementInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:SalesPackageElement:Ordinary

TextInLanguage[] · required

Name.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References to fare tables.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version

Example: NSB:Version:V1

Description.

A LimitingRule

Fare frame ref.

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

VersionOfObjectRef

Fare frame ref.

compatibleWithVersionRef

string

CompatibleWithVersionRef

TemporalValidityParameter

A TemporalValidityParameter

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TemporalValidityParameter:OperatorNSB

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: TemporalValidityParameter

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

GroupOfTimeBands

A GroupOfTimeband describe during which the assignments applies

ValidityCondition

A condition of the validity of the priceable object

VersionOfObjectRef

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

CompatibleWithVersionRef

UVPForNumberOfZonesInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:UVPForNumberOFZones:123

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

numberOfZones

integer · int64 · required

Number of zones.

Example: 3

usageValidityPeriodId

string · required

Reference to usage validity period.

Example: NSB:UsageValidityPeriod:Child

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

zoneRange

string

Zone range.

Example: 4:9

UsageValidityPeriodInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:UsageValidityPeriod:30Days

TextInLanguage[] · required

Name represented in different languages. Language codes are ISO-639.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

UsageValidityPeriod version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

FareTableRef[] · required

References to FareTable.

usageEnd

string · enum

Usage end.

Enum values:

STANDARD_DURATION

END_OF_CALENDAR_PERIOD

END_OF_RIDE

END_OF_TRIP

END_OF_FARE_DAY

END_OF_FARE_PERIOD

PRODUCT_EXPIRY

PROFILE_EXPIRY

usageEnds

string[]

Usage End list.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

usageTrigger

string · enum

Usage trigger.

Enum values:

START_OF_PERIOD

START_OUT_BOUND_RIDE

END_OUT_BOUND_RIDE

START_RETURN_RIDE

PURCHASE

SPECIFIED_START_DATE

FULFILMENT

DAY_OFFSET_BEFORE_CALENDAR_PERIOD

activationMeans

string[]

Activation Means. Describes how a product can be activated.

SteppedDuration

Stepped duration.

standardDuration

string

Standard duration. Represented as a string formatted according to ISO-8601

Example: PT1H

usageValidityTypes

string[]

Usage validity type list.

usageStartConstraintType

string · enum

Usage start constraint.

Enum values:

VARIABLE

FIXED

FIXED_WINDOW

v2.DistributionAssignment

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:DistributionAssignment:Ordinary

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · required

Version

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: DistributionAssignment

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

paymentMethods

string[] · required

Payment methods.

Enum values:

CASH

CASH_AND_CARD

COIN

BANKNOTE

CREDIT_CARD

DEBIT_CARD

CONTACTLESS_PAYMENT_CARD

CARDS_ONLY

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

distributionRights

string · enum · required

Distribution rights.

Enum values:

NONE

SELL

REFUND

EXCHANGE

INFROM

PRIVATE

OTHER

Example: SELL

allDistributionChannelsRef

boolean · required

Flag for distribution in all channels.

TextInLanguage[]

The name of the distribution assignment represented in different languages. Language codes are ISO-639

countryRef

string

Country reference.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639

finalCarrier

boolean

Flag for final carrier.

anyCountryRef

boolean

Flag for allowed in any country.

initialCarrier

boolean

Flag for initial carrier.

transitCarrier

boolean

Flag for transit carrier.

allowedInChannel

boolean

Flag for allowed in channel.

allowedInCountry

boolean

Flag for allowed in country.

mandatoryProduct

boolean

Flag for mandatory product.

ticketingServices

string[]

Ticketing services.

Enum values:

TSF_PURCHASE

COLLECTION

CARD_TOP_UP

RESERVATIONS

allOrganisationRef

boolean

Flag for all organisations.

VersionOfObjectRef

Fare frame ref.

restrictedToChannel

boolean

Flag for restricted to channel.

topographicPlaceRef

string

Topographical place reference.

requiresRegistration

boolean

Flag for requires registration.

responsibilitySetRef

string

Responsibility set reference.

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

distributionChannelType

string · enum

Type of distribution channel.

Enum values:

AT_STOP

ON_BOARD

ONLINE

TELEPHONE

ELECTRONIC_PASS

MOBILE_DEVICE

AGENCY

TOUR_OPERATOR

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

AccessRightInProductInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:AccessRightInProduct:Ordinary

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

accessNumber

integer · int32

The actual access number

maximumAccess

integer · int32

Maximum number of times use of this element may occur in a given trip

minimumAccess

integer · int32

Minimum number of times use of this element must occur in a given trip

orderOfElement

integer · int32

The actual order in the sequence

isLastInSequence

boolean

Whether element is last in sequence

isFirstInSequence

boolean

Whether element is first in sequence

accessNumberIsLimited

boolean

Flag indicating if access number is limited

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

FareStructureElementInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FareStructureElement:TENInterval

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

fare table reference

VersionOfObjectRef[] · required

Access Right Parameter assignments.

VersionOfObjectRef[] · required

geographical interval sequence

TextInLanguage[]

Name.

FarePriceInsert[]

Fare prices.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

TextInLanguage[]

Description.

tariffBasis

string · enum

Tariff basis.

Enum values:

FLAT

DISTANCE

UNIT_SECTION

ZONE

ZONE_TO_ZONE

POINT_TO_POINT

ROUTE

TOUR

Example: DISTANCE

geographicalStructureFactorId

string

Geographical structure factor id

Example: NSB:GeographicalStructureFactor:TENPrices

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

GenericParameterAssignment

A GenericParameterAssignment

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GenericParameterAssignment:AllowedOperators

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

Changed datetime.

created

string · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V2

nameOfClass

string · required

Name of class

Example: GenericParameterAssignment

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

GenericParameterAssignment[]

Includes genericParameterAssignments.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

Limitations as UsageParameters.

requiredType

string · enum

Required type.

Enum values:

SERVICE_JOURNEY_REF

TARIFF_ZONE_REF

PASSENGER_SEAT_REF

USER_PROFILE_REF

USAGE_VALIDITY_PERIOD_REF

DATED_SERVICE_JOURNEY_REF

DYNAMIC_DISTANCE_MATRIX_ELEMENT

USAGE_VALIDITY_PERIOD

Example: SERVICE_JOURNEY_REF

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

requiredElements

string[]

Required elements.

chargingBasisType

string · enum

ChargingBasisType.

Enum values:

FREE

DISCOUNTED

NORMAL

ANY

Example: FREE

requiredInContext

string · enum

Required in context.

Enum values:

OFFERING

BOOKING

RESERVATION

SALE

FULFILMENT

ACTIVATION

CONSUMPTION

REVALIDATION

ScopingValidityParameter[]

Validity parameters as scoping validity parameters

canIgnoreInOffering

boolean

Indicates whether gpa leaf node is supposed to be ignored when generating offer.

Example: true

VersionOfObjectRef

Fare frame ref.

includesGroupingType

string · enum

Includes grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

derivedFromVersionRef

string

Derived from version.

Example: NSB:Version:V1

limitationGroupingType

string · enum

Limitation grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

VersionOfObjectRef

Fare frame ref.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

Example: NSB:Version:V1

comparisonOperatorVariant

string

Indicates whether a gpa belongs to A or E gpa implementation.

Example: A

TemporalValidityParameter[]

Temporal validity parameter.

TypeOfAccessRightAssignment

A classification of Access Right Assignments.

VersionOfObjectRef

Fare frame ref.

validityParameterGroupingType

string · enum

Validity parameter grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

validityParameterAssignmentType

string · enum

Validity parameter assignment type.

Enum values:

EQ

NE

GT

LT

GE

LE

Example: EQ

validityParameterSetSelectionType

string · enum

Validity parameter set operator.

Enum values:

ONE_OF_ANY_ONE_SET

ONE_OF_EACH_SET

SOME_OF_ANY_SET

ALL_OF_ONE_SET

ALL_OF_ALL_SETS

GeographicalIntervalInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GeographicalInterval:1364TEN

FarePriceInsert[] · required

Prices for the fare.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

Reference to fare table.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Version.

Example: NSB:Version:V1

intervalType

string · enum

IntervalType.

Enum values:

STOP

TARIFF_ZONE

DISTANCE

COUPON

OTHER

numberOfUnits

number · double

NumberOfUnits.

endGeographicalValue

integer · int64

EndGeographicalValue.

startGeographicalValue

integer · int64

StartGeographicalValue.

TypeOfUsageParameterInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfUsageParameter:ThroughFareInterchanging

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

DistanceMatrixElementInsert

A DistanceMatrixElement create request

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:DistanceMatrixElement:NSR167ToNSR359

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

DistanceMatrixElement version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.

FarePriceInsert[]

Fare prices for the user profile.

distance

number · double

Distance.

Example: 16.4

VersionOfObjectRef

Fare frame ref.

isDirect

boolean

Is a direct route.

Example: true

VersionOfObjectRef

Fare frame ref.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the user profile.

endFareZoneRef

string

End fare zone reference.

inverseAllowed

boolean

Inverse is allowed.

Example: true

VersionOfObjectRef

Fare frame ref.

relativeRanking

integer · int32

Relative ranking.

Example: 2

startFareZoneRef

string

Start fare zone reference.

ValidityCondition[]

Validity conditions for the user profile.

endScheduledStopPointId

string

End scheduled stop point netexId.

startScheduledStopPointId

string

Start scheduled stop point netexId.

GeographicalStructureFactor

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id

Example: NSB:GeographicalStructureFactor:50TEN

TextInLanguage[] · required

The name of the geographical structure factor represented in different languages. Language codes are ISO-639

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

TextInLanguage[] · required

Description represented in different languages. Language codes are ISO-639

nameOfClass

string · readOnly · required

Name of class

Example: GeographicalStructureFactor

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

GeographicalInterval[] · required

Geographical intervals

DistanceMatrixElement[] · required

Distance matrix elements

geographicalUnitRef

string

Geographical unit ref

SeqExplainedMessageResponse

Translated messages explaining the failure

empty

boolean

traversableAgain

boolean

TransferabilityAlternatives

Transferability alternatives for an element.

IdAndVersion · required

Describes the ID and version of an element.

Transferability[] · required

Transferability alternatives for this element.

TypeOfAccessRightAssignment

A classification of Access Right Assignments.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment

status

string · enum · readOnly · required

Type of access right assignment status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Type of access right assignment version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: TypeOfAccessRightAssignment

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

ValidableElementPageWrapper

Validable Element Page Wrapper

ValidableElement[] · readOnly · required

Validable elements for the given page

totalNumberOfItems

integer · int32 · required

Total number of items.

Example: 369

totalNumberOfPages

integer · int32 · readOnly · required

Number of pages needed to traverse all items.

Example: 15

requestedPageNumber

integer · int32 · required

Number of the requested page. In case state is lost

Example: 1

DistributionAssignmentInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:DistributionAssignment:Ordinary

TextInLanguage[] · required

Name.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

distributionRights

string · enum · required

Distribution rights.

Enum values:

NONE

SELL

REFUND

EXCHANGE

INFROM

PRIVATE

OTHER

Example: SELL

allDistributionChannelsRef

boolean · required

Flag for distribution in all channels.

TextInLanguage[]

Description.

paymentMethods

string[]

Payment methods.

VersionOfObjectRef

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

distributionChannelRef

string

Distribution channel Ref.

compatibleWithVersionRef

string

CompatibleWithVersionRef

VersionOfObjectRef

Fare frame ref.

PreassignedFareProductInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

TextInLanguage[] · required

Name.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

operatorRef

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

OperatorRef.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

organisation

string · required

Organisation.

VersionOfObjectRef · required

Fare frame ref.

FarePriceInsert[]

Fare prices.

TextInLanguage[]

Description.

privateCode

string

PrivateCode.

productType

string · enum

The type of fare product.

Enum values:

SINGLE_TRIP

Example: SINGLE_TRIP

VersionOfObjectRef[]

FareTableRef.

ConditionSummaryInsert

ConditionSummary.

vatGroupRegister

string · enum

VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: ZONE_TO_ZONE_FARE

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

VersionOfObjectRef

Fare frame ref.

AccessRightInProductInsert[]

AccessRightsInProduct.

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active.

Example: A

VersionOfObjectRef[]

AccessRightParameterAssignments.

SaleDiscountRightPageWrapper

SeqSaleDiscountRight[] · readOnly · required

SaleDiscountRights for the given page

totalNumberOfItems

integer · int32 · readOnly · required

Total number of items.

Example: 369

totalNumberOfPages

integer · int32 · readOnly · required

Number of pages needed to traverse all items.

Example: 15

requestedPageNumber

integer · int32 · readOnly · required

Number of the requested page. In case state is lost

Example: 13

SeqUVPForNumberOfZonesInsert

empty

boolean

traversableAgain

boolean

SeqUsageValidityPeriodInsert

empty

boolean

traversableAgain

boolean

GroupOfDistanceMatrixElements

A GroupfOfDistanceMatrixElemenets

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupOfDistanceMatrixElements:TENDistances

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

GroupOfDistanceMatrixElements version.

Example: NSB:Version:V1

membersId

string · required

DistanceMatrixElements within the group.

nameOfClass

string · required

Name of class.

Example: GroupOfDistanceMatrixElements

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.

tariffId

integer · int64

Tariff id.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

fareFrameId

integer · int64

Fare frame id.

ValidityCondition[]

Validity conditions for the user profile.

ParameterPossibilitiesRequest

Request for retrieving refunding alternatives for elements.

IdAndVersion[]

Sales packages the user wants to retrieve the parameter alternatives for.

IdAndVersion[]

Validable elements the user wants to retrieve the parameter alternatives for.

IdAndVersion[]

Fare structure elements the user wants to retrieve the parameter alternatives for.

IdAndVersion[]

Preassigned products the user wants to retrieve the parameter alternatives for.

SeqGeographicalIntervalInsert

empty

boolean

traversableAgain

boolean

FareStructureElementInSequence

A description of a fare structure element in sequence

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FareStructureElementInSequence:MiniPriceTENInterval

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Fare structure element in sequence version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: FareStructureElementInSequence

accessNumber

integer · int32 · required

The actual ordering in the sequence

VersionOfObjectRef · required

Fare frame ref.

fareStructureElementId

string · required

Fare structure element ref

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

Name.

TextInLanguage[]

Description.

orderOfElement

integer · int32

Access quality structure factor refs

isLastInSequence

boolean

Gives information if this sequence last or not

isFirstInSequence

boolean

Gives information if this sequence first or not

limitedAccessNumber

integer · int32

Flag indicating whether this rights gives an unlimited number of accesses or not

ScopingValidityParameterInsert

A ScopingValidityParameter

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:ScopingValidityParameter:OperatorNSB

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

changed

string · date-time

created

string · date-time

lineRef

string

LineRef.

lineType

string · enum

LineType.

Enum values:

LOCAL

URBAN

LONG_DISTANCE

EXPRESS

SEASONAL

REPLACEMENT

FLEXIBLE

CORRIDOR_SERVICE

Example: EXPRESS

placeUse

string · enum

PlaceUse

Enum values:

START_AT

END_AT

VIA

RESTRICT_TO

OTHER

fareClasses

string[]

Fare class list.

fareZoneRef

string

FareZoneRef.

Example: KOL:FareZone:250

nameOfClass

string

operatorRef

string

Operator referance.

vehicleMode

string · enum

VehicleModeRef.

Enum values:

AIR

BUS

COACH

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

authorityRef

string

AuthorityRef.

Example: NSB:Authority:NSB

facilitySetRef

string

facilitySetRef.

fareSectionRef

string

Fare section ref.

groupOfLinesRef

string

Group of lines ref.

Example: ENT:GroupOfLines:AllLines

transportSubmode

string · enum

TransportSubmode.

Enum values:

unknown

undefined

internationalFlight

domesticFlight

intercontinentalFlight

domesticScheduledFlight

shuttleFlight

intercontinentalCharterFlight

Example: expressBus

topographicPlaceRef

string

TopographicPlaceRef

derivedFromVersionRef

string

Derived from version.

groupOfTariffZonesRef

string

Group of Tariff Zones ref

Example: ENT:GroupOfTariffZones:AllZones

scheduledStopPointRef

string

Scheduled stop Point ref.

distributionChannelRef

string

Reference to a DISTRIBUTION CHANNEL to which the ACCESS RIGHT PARAMETER ASSIGNMENTs applies.

Example: ENT:DistributionChannel:App

compatibleWithVersionRef

string

CompatibleWithVersionRef

FareStructureElementPageWrapper

FareTablePageWrapper

FareStructureElement[] · readOnly · required

Fare structure elements for the given page

totalNumberOfItems

integer · int32 · required

Total number of items.

Example: 369

totalNumberOfPages

integer · int32 · readOnly · required

Number of pages needed to traverse all items.

Example: 15

requestedPageNumber

integer · int32 · required

Number of the requested page. In case state is lost

Example: 369

TemporalValidityParameterInsert

A TemporalValidityParameter

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TemporalValidityParameter:OperatorNSB

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

changed

string · date-time

created

string · date-time

VersionOfObjectRef

Fare frame ref.

nameOfClass

string

GroupOfTimeBands

A GroupOfTimeband describe during which the assignments applies

ValidityCondition

A condition of the validity of the priceable object

VersionOfObjectRef

Fare frame ref.

GenericParameterAssignmentInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GenericParameterAssignment:AllowedOperators

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V2

VersionOfObjectRef · required

Fare frame ref.

GenericParameterAssignmentInsert[]

Includes genericParameterAssignments.

VersionOfObjectRef[]

Limitations as UsageParameters.

requiredType

string · enum

Required type.

Enum values:

SERVICE_JOURNEY_REF

TARIFF_ZONE_REF

PASSENGER_SEAT_REF

USER_PROFILE_REF

USAGE_VALIDITY_PERIOD_REF

DATED_SERVICE_JOURNEY_REF

DYNAMIC_DISTANCE_MATRIX_ELEMENT

USAGE_VALIDITY_PERIOD

Example: SERVICE_JOURNEY_REF

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

requiredElements

string · enum

Required elements.

Enum values:

START_DATE

START_TIME

STANDARD_DURATION

START_STOP_POINT_REF

END_STOP_POINT_REF

START_TARIFF_ZONE_REF

END_TARIFF_ZONE_REF

Example: START_DATE

chargingBasisType

string · enum

ChargingBasisType.

Enum values:

FREE

DISCOUNTED

NORMAL

ANY

Example: FREE

requiredInContext

string · enum

Required in context.

Enum values:

OFFERING

BOOKING

RESERVATION

SALE

FULFILMENT

ACTIVATION

CONSUMPTION

REVALIDATION

ScopingValidityParameterInsert[]

Validity parameters as scoping validity parameters

canIgnoreInOffering

boolean

Indicates whether gpa leaf node is supposed to be ignored when generating offer.

Example: true

VersionOfObjectRef

Fare frame ref.

includesGroupingType

string · enum

Includes grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

derivedFromVersionRef

string

Derived from version.

Example: NSB:Version:V1

limitationGroupingType

string · enum

Limitation grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

VersionOfObjectRef

Fare frame ref.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

Example: NSB:Version:V1

comparisonOperatorVariant

string

Indicates whether a gpa belongs to A or E gpa implementation.

Example: A

TemporalValidityParameterInsert[]

Temporal Validity parameter.

TypeOfAccessRightAssignment

A classification of Access Right Assignments.

VersionOfObjectRef

Fare frame ref.

validityParameterGroupingType

string · enum

Validity parameter grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

validityParameterAssignmentType

string · enum

Validity parameter assignment type.

Enum values:

EQ

NE

GT

LT

GE

LE

Example: EQ

validityParameterSetSelectionType

string · enum

Validity parameter set operator.

Enum values:

ONE_OF_ANY_ONE_SET

ONE_OF_EACH_SET

SOME_OF_ANY_SET

ALL_OF_ONE_SET

ALL_OF_ALL_SETS

PreassignedFareProductPageWrapper

PreassignedFareProductWrapper

PreassignedFareProduct[] · readOnly · required

Preassigned fare products for the given page

totalNumberOfItems

integer · int32 · required

Total number of items.

Example: 369

totalNumberOfPages

integer · int32 · readOnly · required

Number of pages needed to traverse all items.

Example: 15

requestedPageNumber

integer · int32 · required

Requested page number.

Example: 1

GroupOfDistanceMatrixElementsInsert

A GroupDistanceMatrixElement create request

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:GroupOfDistanceMatrixElements:TENDistances

members

string[] · required

DistanceMatrixElements within the group.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

GroupOfDistanceMatrixElements version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.

tariffId

integer · int64

Tariff id.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

fareFrameId

integer · int64

Fare frame id.

ValidityCondition[]

Validity conditions for the user profile.

FareStructureElementInSequenceInsert

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:FareStructureElementInSequence:MiniPriceTENInterval

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

fareStructureElementId

string · required

Fare structure element id

Example: NSB:FareStructureElement:TENInterval

TextInLanguage[]

Name.

TextInLanguage[]

Description.

accessNumber

integer · int32

The actual access number

orderOfElement

integer · int32

Access quality structure factor refs

isLastInSequence

boolean

Whether element is last in sequence

isFirstInSequence

boolean

Whether element is first in sequence

limitedAccessNumber

integer · int32

Flag indicating whether this rights gives an unlimited number of accesses or not