Schemas

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

isFirstInSequence

boolean

Whether element is first in sequence

isLastInSequence

boolean

Whether element is last in sequence

limitedAccessNumber

integer · int32

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

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

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

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

nameOfClass

string · readOnly

Name of class.

Example: Refunding

orderOfElement

integer · int32

The actual order in the sequence

status

string · enum · readOnly

Access right in product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

AccessRightInProductInsert

VersionOfObjectRef · required

Fare frame ref.

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.

accessNumber

integer · int32

The actual access number

accessNumberIsLimited

boolean

Flag indicating if access number is limited

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

isFirstInSequence

boolean

Whether element is first in sequence

isLastInSequence

boolean

Whether element is last in sequence

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

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

orderOfElement

integer · int32

The actual order in the sequence

Accommodation

An Accommodation

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

id

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

Id.

Example: NSB:Accommodation:Sleeper

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: Accommodation

status

string · enum · readOnly · 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

accommodationFacility

string · enum

Accommodation facility.

Enum values:

SLEEPER

SEATING

DOUBLE_SLEEPER

SINGLE_SLEEPER

SPECIAL_SLEEPER

COUCHETTE

SINGLE_COUCHETTE

DOUBLE_COUCHETTE

Example: SLEEPER

nuisanceFacilities

string[]

List of nuisance facilities

AmountOfPriceUnitProduct

An Amount Of Price Unit Product response

amount

integer · int32 · min: 1 · required

Amount. Must be greater than 0.

Example: 10

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: RUT:AmountOfPriceUnitProduct:RuterCarnetTicket

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

productType

string · enum · required

AmountOfPriceUnitProductType.

Enum values:

TRIP_CARNET

PASS_CARNET

UNIT_COUPON

STORED_VALUE

OTHER

Example: TRIP_CARNET

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

VersionOfObjectRef[] · writeOnly

AccessRightParameterAssignmentRefs.

GenericParameterAssignment[] · readOnly

AccessRightParameterAssignments.

AccessRightInProduct[]

AccessRightsInProduct.

activeComparisonOperatorVariant

string

Deprecated: this parameter is ignored.

Example: E

changed

string · readOnly

Changed datetime.

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string · readOnly

CompatibleWithVersionRef

A summary of a condition.

created

string · readOnly

Created datetime.

derivedFromVersionRef

string · readOnly

Derived from version.

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

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

FareTableRef.

Fare frame ref.

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

nameOfClass

string · readOnly

Name of class.

Example: AmountOfPriceUnitProduct

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

organisation

string

Organisation who own the product.

organisationId

string

Organisation related to the userProfile

privateCode

string

PrivateCode.

A classification of FARE PRODUCTs.

ValidityCondition[] · readOnly

ValidityCondition.

version

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

Version

Example: NSB:Version:V1

AreaValidity

Requirements for area validity.

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

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

Id.

Example: RUT:AreaValidity:RuterSingleTicket

minimumZonesForAreaValidity

integer · int32 · required

Minimum no. of zones for area validity.

Example: 5

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: AreaValidity

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Version.

Example: RUT:Version:V1

compatibleWithVersionRef

string · readOnly

Compatible with version.

derivedFromVersionRef

string · readOnly

Derived from version.

groupOfTariffZoneRef

string

Group of tariff zone

Example: ENT:GroupOfTariffZone:abcdef

AvailabilityCondition

An AvailabilityCondition

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef · required

Fare frame ref.

fromDate

string · required

FromDate datetime.

id

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

Id.

Example: ENT:AvailabilityCondition:SomeId

isAvailable

boolean · required

Is available

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: AvailabilityCondition

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

toDate

string · required

toDate datetime.

version

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

AvailabilityCondition version.

Example: ENT:Version:SomeVersion

available

boolean

Day Type references.

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

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

organisationId

string

Organisation related to the userProfile

Time band references.

BoxedUnit

CappedDiscountRight

A Capped Discount Right response

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: ENT:CappedDiscountRight:BestePrisFylket

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: CappedDiscountRight

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

ValidityCondition.

vatGroupRegister

string · enum · required

VatGroupRegister.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

version

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

Version

Example: NSB:Version:V1

AccessRightParameterAssignments.

AccessRightInProduct[]

AccessRightsInProduct.

activeComparisonOperatorVariant

string

Deprecated: this parameter is ignored.

Example: E

CappingRule[]

Capping rules.

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string

CompatibleWithVersionRef

A summary of a condition.

derivedFromVersionRef

string

Derived from version.

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

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

FareTableRef.

Fare frame ref.

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

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

organisation

string

Organisation who own the product.

organisationId

string

Organisation related to the userProfile

Prices.

privateCode

string

PrivateCode.

A classification of FARE PRODUCTs.

validationRequirements

string[]

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

CappedDiscountRightInsert

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: ENT:CappedDiscountRight:BestePrisFylket

TextInLanguage[] · required

Name.

operatorRef

string · required

OperatorRef.

Example: RUT:Authority:RUT

organisation

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

Organisation.

version

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

Version.

Example: NSB:Version:V1

AccessRightInProductInsert[]

AccessRightParameterAssignments.

AccessRightsInProduct.

activeComparisonOperatorVariant

string

Deprecated: this parameter is ignored.

Example: E

CappingRuleInsert[]

Capping rules.

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string

Compatible with version.

ConditionSummaryInsert

ConditionSummary.

derivedFromVersionRef

string

Derived from version.

Description.

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

FareTableRef.

Prices.

privateCode

string

PrivateCode.

Fare frame ref.

validationRequirements

string[]

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

vatGroupRegister

string · enum

VatGroupRegister.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

CappingRule

activeComparisonOperatorVariant

string · required

Deprecated: this parameter will be ignored.

Example: E

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: ENT:CappingRule:EnkeltbillettTil24Timer

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: CappingRule

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

Access Right Parameter assignments.

cappingPeriod

string · enum

Period over which capping applies.

Enum values:

DAY

WEEK

MONTH

Example: DAY

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

Reference to fare table.

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

Fare frame ref.

Prices for the fare.

Fare frame ref.

Validity conditions.

CappingRuleInsert

VersionOfObjectRef[] · required

Access Right Parameter assignment references.

activeComparisonOperatorVariant

string · required

Deprecated: this parameter will be ignored.

Example: E

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

FareTableRef.

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

cappingPeriod

string · enum

Period over which capping applies.

Enum values:

DAY

WEEK

MONTH

Example: DAY

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

Fare frame ref.

Fare prices.

Fare frame ref.

Cell

changed

string · required

Changed datetime.

created

string · required

Created datetime.

FarePrice · required

A description of the price and factor for a set fare

id

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

Id.

Example: RUT:Cell:5zoneAdult

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Cell

VersionOfObjectRef[] · required

References to for example geographical interval and UserProfile

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

channelGroupRef

object

Channel group reference

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

Description.

Name.

CellInsert

VersionOfObjectRef · required

Fare frame ref.

FarePriceInsert · required

id

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

Id.

Example: RUT:Cell:5zoneAdult

TextInLanguage[] · required

Name.

Fare frame ref.

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

Description.

Fare frame ref.

References to for example geographical interval and UserProfile

version

string

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.

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:ChargingMoment:Prepaid

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: ChargingMoment

status

string · enum · readOnly · required

Charging moment status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Charging moment version.

Example: NSB:Version:V1

compatibleWithVersionRef

string · readOnly

Compatible with version.

derivedFromVersionRef

string · readOnly

Derived from version.

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

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

ChargingMomentInsert

VersionOfObjectRef · required

Fare frame ref.

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

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

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

ChargingPolicy

A ChargingPolicy response

changed

string · readOnly · required

ChargingPolicy changed datetime.

created

string · readOnly · required

ChargingPolicy create datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:ChargingPolicy:Ordinary

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: ChargingPolicy

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

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

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

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

expireAfterPeriod

string

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

Example: PT1H

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

paymentGracePeriod

string

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

Example: PT1H

typeOfUsageParameter

string

type of UsageParameter.

version

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

Version

Example: NSB:Version:V1

CompanionProfile

A companion profile

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:CompanionProfile:Adult

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: CompanionProfile

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

The version of the companion profile.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

discountBasis

string · enum

Basis for discount.

Enum values:

NONE

FREE

DISCOUNT

FULLRATE

Example: DISCOUNT

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

Fare frame ref.

Fare frame ref.

maximumNumberOfPersons

integer · int32

Maximum number of allowed companions.

minimumNumberOfPersons

integer · int32

Minimum number of allowed companions.

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

Fare frame ref.

Fare prices for the companion profile.

typeOfUsageParameter

string

typeOfUsageParameter.

userProfileId

string

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

Fare frame ref.

Validity conditions for the companion profile.

CompanionProfileInject

A companion profile create request

VersionOfObjectRef · required

Fare frame ref.

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

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

discountBasis

string · enum

Basis for discount.

Enum values:

NONE

FREE

DISCOUNT

FULLRATE

Example: DISCOUNT

Fare frame ref.

maximumNumberOfPersons

integer · int32

Maximum number of allowed companions.

minimumNumberOfPersons

integer · int32

Minimum number of allowed companions.

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

Fare frame ref.

Fare prices for the companion profile.

typeOfUsageParameter

string

typeOfUsageParameter.

userProfileId

string

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

Fare frame ref.

ConditionSummary

A summary of a condition.

id

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

Id.

Example: NSB:ConditionSummary:1005TEN

isExchangeable

boolean

Whether the ticket is exchangeable.

Example: true

isRefundable

boolean

Whether the ticket is refundable.

Example: true

ConditionSummaryInsert

ConditionSummary.

id

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

Id.

Example: NSB:ConditionSummary:1005TEN

isExchangeable

boolean

Whether the ticket is exchangeable.

Example: true

isRefundable

boolean

Whether the ticket is refundable.

Example: true

Count

numberOfElements

integer · int32 · required

number of elements

Example: 369

DayType

The DayType describe during which the assignment applies

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

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

Id.

Example: ENT:DayType:BicycleFlatFare

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: DayType

status

string · enum · readOnly · 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

dayLength

string

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

Example: PT04H

Description of day type

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

earliestTime

string

Earliest time.

Example: 11:11:11

Name of day type

PropertyOfDay[]

Properties of day

Time band references.

DistanceMatrixElement

A DistanceMatrixElement

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:DistanceMatrixElement:NSR167ToNSR359

nameOfClass

string · readOnly · required

Name of class.

Example: DistanceMatrixElement

version

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

DistanceMatrixElement version.

Example: NSB:Version:V1

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

distance

number · double

Distance.

Example: 16.4

endFareZoneRef

string

End fare zone reference.

endScheduledStopPointId

string

End scheduled stop point netexId.

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

groupId

integer · int64

Group id.

Example: 4

Fare frame ref.

inverseAllowed

boolean

Inverse is allowed.

Example: true

isDirect

boolean

Is a direct route.

Example: true

Fare frame ref.

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

Fare prices for the user profile.

relativeRanking

integer · int32

Relative ranking.

Example: 2

startFareZoneRef

string

Start fare zone reference.

startScheduledStopPointId

string

Start scheduled stop point netexId.

tariffId

integer · int64

Tariff id.

Fare frame ref.

Validity conditions for the user profile.

DistanceMatrixElementInsert

A DistanceMatrixElement create request

VersionOfObjectRef · required

Fare frame ref.

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

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

distance

number · double

Distance.

Example: 16.4

endFareZoneRef

string

End fare zone reference.

endScheduledStopPointId

string

End scheduled stop point netexId.

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

Fare frame ref.

inverseAllowed

boolean

Inverse is allowed.

Example: true

isDirect

boolean

Is a direct route.

Example: true

Fare frame ref.

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

Fare prices for the user profile.

relativeRanking

integer · int32

Relative ranking.

Example: 2

startFareZoneRef

string

Start fare zone reference.

startScheduledStopPointId

string

Start scheduled stop point netexId.

Fare frame ref.

Validity conditions for the user profile.

DistributionAssignment

A distributionAssignment

allDistributionChannelsRef

boolean · required

Flag for distribution in all channels.

changed

string · required

Changed datetime.

created

string · required

Created datetime.

distributionRights

string · enum · required

Distribution rights.

Enum values:

NONE

SELL

REFUND

EXCHANGE

INFROM

PRIVATE

OTHER

Example: SELL

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:DistributionAssignment:Ordinary

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: DistributionAssignment

VersionOfObjectRef · required

Fare frame ref.

paymentMethods

string[] · required

Payment methods.

VersionOfObjectRef · required

Fare frame ref.

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

allOrganisationRef

boolean

Flag for all organisations.

allowedInChannel

boolean

Flag for allowed in channel.

allowedInCountry

boolean

Flag for allowed in country.

anyCountryRef

boolean

Flag for allowed in any country.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

countryRef

string

Country reference.

derivedFromVersionRef

string

Derived from version.

Description.

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

finalCarrier

boolean

Flag for final carrier.

Fare frame ref.

Fare frame ref.

Fare frame ref.

initialCarrier

boolean

Flag for initial carrier.

mandatoryProduct

boolean

Flag for mandatory product.

Name.

requiresRegistration

boolean

Flag for requires registration.

responsibilitySetRef

string

Responsibility set reference.

restrictedToChannel

boolean

Flag for restricted to channel.

Fare frame ref.

ticketingServices

string[]

Ticketing services.

topographicPlaceRef

string

Topographical place reference.

transitCarrier

boolean

Flag for transit carrier.

DistributionAssignmentInsert

allDistributionChannelsRef

boolean · required

Flag for distribution in all channels.

distributionRights

string · enum · required

Distribution rights.

Enum values:

NONE

SELL

REFUND

EXCHANGE

INFROM

PRIVATE

OTHER

Example: SELL

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:DistributionAssignment:Ordinary

TextInLanguage[] · required

Name.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

version

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

Version

Example: NSB:Version:V1

compatibleWithVersionRef

string

CompatibleWithVersionRef

derivedFromVersionRef

string

Derived from version.

Description.

distributionChannelRef

string

Distribution channel Ref.

Fare frame ref.

Fare frame ref.

paymentMethods

string[]

Payment methods.

ElementUsages

ParameterUsages

Parameters usages mapped to the requested parameter.

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

classOfUseConstraint

string · enum

Class of use constraint

Enum values:

ANY

SAME

SAME_OR_EQUIVALENT

DIFFERENT

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

directionConstraint

string · enum

Direction constraint

Enum values:

ANY

SAME

OPPOSITE_DIRECTION

DIFFERENT

FareScheduledStopPoint[]

Fare scheduled stop points 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

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

routeConstraint

string · enum

Route constraint

Enum values:

ANY

SAME

OPPOSITE_DIRECTION

DIFFERENT

specificProfiles

string[]

Specific user profiles which entitlement applies

tariffZoneConstraint

string · enum

Tariff zone constraint

Enum values:

ANY

SAME

SAME_AS_ORIGIN

SAME_AS_DESTINATION

SAME_AS_ORIGIN_OR_DESTINATION

WITHIN

CONTAINING

EQUIVALENT

typeOfProductCategoryConstraint

string · enum

Type of product category constraint

Enum values:

ANY

SAME

SAME_OR_EQUIVALENT

DIFFERENT

typeOfTravelDocumentConstraint

string · enum

Type of travel document constraint

Enum values:

ANY

SAME

SAME_MEDIA

SAME_SMART_CARD

SAME_MOBILE_APP

DIFFERENT

userConstraint

string · enum

User constraint

Enum values:

ANYONE

SAME_PERSON

DIFFERENT_PERSON

SPECIFIC

EntitlementGiven

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

TextInLanguage[] · required

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

entitlementType

string · enum · required

Entitlement type

Enum values:

USE

PURCHASE

PURCHASE_AT_DISCOUNT

NONE

VersionOfObjectRef · required

Fare frame ref.

id

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

Id

Example: NSB:EntitlementGiven:TrondelagCustomerCard

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[] · required

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

nameOfClass

string · readOnly · required

Name of class

Example: EntitlementGiven

FarePrice[] · required

Prices for the entitlement given.

status

string · enum · readOnly · 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

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.

minimumQualificationPeriod

string

Minimum qualification period

Example: 01:59:59.999999999

Fare frame ref.

EntitlementProduct

An ENTITLEMENT PRODUCT response.

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

string · required

Id.

Example: RUT:EntitlementProduct:PersonalTicket

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: EntitlementProduct

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

ValidityCondition.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

derivedFromVersionRef

string

Derived from version.

Description.

FareTableRef.

Fare frame ref.

Name.

organisation

string

Organisation who own the product.

privateCode

string

PrivateCode.

A classification of FARE PRODUCTs.

version

string

Version.

Example: NSB:Version:V1

EntitlementRequired

Entitlement Required.

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

TextInLanguage[] · required

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

VersionOfObjectRef · required

Fare frame ref.

id

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

Id

Example: ENT:EntitlementRequired:SingleTicket

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[] · required

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

nameOfClass

string · readOnly · required

Name of class

Example: EntitlementRequired

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Version

Example: ENT:Version:ER-SingleTicket-1

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.

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

organisationId

string

Organisation related to the userProfile

Fare prices for the entitlement required.

serviceAccessRightNetexId

string

Reference to the serviceAccessRight required.

Example: ENT:PreassignedFareProduct:SingleTicket

typeOfUsageParameter

string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

Pricing rule reference.

Exchanging

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Exchanging:MiniFlex

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Exchanging

status

string · enum · required

Exchanging status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

allowed

string · enum

Allowed.

Enum values:

NONE

PARTIAL

FULL

Example: FULL

canChangeClass

boolean

Whether user can change class.

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

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

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

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

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

References for associated fare tables.

hasFee

boolean

Has fee.

A LimitingRule

Fare frame ref.

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

numberOfExchangesAllowed

integer · int32

Number of times a ticket may be exchanged.

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

Prices in different currencies for the exchanging rule.

refundBasis

string · enum

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

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

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

specifiedProducts

string[]

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

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

unusedTicketsOnly

boolean

Unused tickets only.

version

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

Exchanging version.

Example: NSB:Version:V1

ExchangingAlternatives

Exchanging alternatives for an element.

Exchanging[] · required

Exchanging alternatives for this element.

IdAndVersion · required

Describes the ID and version of an element.

ExchangingInsert

VersionOfObjectRef · required

Fare frame ref.

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

allowed

string · enum

Allowed.

Enum values:

NONE

PARTIAL

FULL

Example: FULL

canChangeClass

boolean

Whether user can change class.

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

exchangeableFromDuration

string

Exchangeable from duration.

Example: PT24H

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

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration

string

Exchangeable until duration.

Example: PT24H

hasFee

boolean

Has fee.

numberOfExchangesAllowed

integer · int32

Number of times a ticket may be exchanged.

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

Fare prices.

refundBasis

string · enum

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

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

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

specifiedProducts

string

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

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

unusedTicketsOnly

boolean

Unused tickets only.

FareDayType

The FareDayType describe during which the assignment applies

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

TextInLanguage[] · required

Description of fare day type

id

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

Id.

Example: NSB:FareDayType:2HoursValidPlus1

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[] · required

Name of fare day type

nameOfClass

string · readOnly · required

Name of class.

Example: FareDayType

status

string · enum · readOnly · 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

dayLength

string

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

Example: PT04H

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

earliestTime

string

Earliest time.

Example: 11:11:11

PropertyOfDay[]

Properties of day

Time band references.

FareFrame

A FareFrame

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

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

Id.

Example: NSB:FareFrame:Child

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: FareFrame

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

FareFrame version.

Example: NSB:Version:V1

compatibleWithVersionRef

string · readOnly

Compatible with version.

derivedFromVersionRef

string · readOnly

Derived from version.

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

FareProduct[]

FareProducts.

FareStructureElement[]

FareStructureElements.

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

SalesPackage[]

SalesPackages.

transportOrganisationNameOfClass

string

Transport organisation nameOfClass.

Example: 16

transportOrganisationNetexId

string

Transport organisation netexId.

transportOrganisationRef

string

Transport organisation ref.

Example: CHILD

transportOrganisationVersion

string

Transport organisation version.

Example: 4

typeOfFareFrameNetexId

string

Type of fareFrame netexId.

Fare frame ref.

typeOfFareFrameVersion

string

Type of fareFrame version.

ValidableElement[]

ValidableElements.

Validity condition.

vehicleMode

string · enum

Vehicle mode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

FarePointInPattern

A Fare Point In Pattern

id

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

Id

Example: NSB:FarePointInPattern:TrondheimOslo

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

orderOfElement

integer · int32 · required

Order of element

pointRef

string · required

Point Ref

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

changed

string · readOnly

Changed datetime

created

string · readOnly

Created datetime

nameOfClass

string · readOnly

Name of class

Example: FarePointInPattern

ValidityCondition[] · readOnly

Validity Conditions.

FarePrice

A description of the price and factor for a set fare

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

string · minLength: 1 · required

Id.

Example: NSB:FarePrice:1005TEN

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: FarePrice

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

amount

string

Amount

Example: 164.0

canBeCumulative

boolean

canBeCumulative.

Example: true

compatibleWithVersionRef

string

Compatible with version.

currency

string

Currency.

Example: NOK

derivedFromVersionRef

string

Derived from version.

discountPercentageUsed

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

discountPercentageUsed.

Example: 5

isAllowed

boolean

isAllowed.

Example: true

A LimitingRule

Name.

ranking

integer · int32

Ranking.

Example: 1

Fare frame ref.

vatRegisterGroup

string · enum

vatRegisterGroup.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

version

string · readOnly

Version.

Example: NSB:Version:V1

FarePriceInsert

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:FarePrice:1005TEN

TextInLanguage[] · required

Name.

amount

string

Amount.

Example: 164.0

canBeCumulative

boolean

canBeCumulative.

Example: true

compatibleWithVersionRef

string

Compatible with version.

currency

string

Currency.

Example: NOK

derivedFromVersionRef

string

Derived from version.

discountPercentageUsed

integer · int32

discountPercentageUsed.

Example: 5

isAllowed

boolean

isAllowed.

Example: true

A LimitingRule

ranking

integer · int32

Ranking.

Example: 1

Fare frame ref.

vatRegisterGroup

string · enum

vatRegisterGroup.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

version

string

FarePriceUpdate

amount

number · double

Amount in the currency selected at create operation

Example: 16.5

discountPercentageUsed

integer · int32

Discount in percentageUsed

Example: 40

FareProduct

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

GenericParameterAssignment[] · required

AccessRightParameterAssignments.

AccessRightInProduct[] · required

AccessRightsInProduct.

changed

string · required

SalesPackage changed datetime.

created

string · required

SalesPackage create datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: PreassignedFareProduct

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

ValidityCondition.

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored.

Example: E

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string

CompatibleWithVersionRef

A summary of a condition.

derivedFromVersionRef

string

Derived from version.

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

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

FareTableRef.

Fare frame ref.

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

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

organisation

string

Organisation who own the product.

organisationId

string

Organisation related to the fareProduct

privateCode

string

PrivateCode.

A classification of FARE PRODUCTs.

version

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

Version

Example: NSB:Version:V1

FareQuotaFactor

A FareQuotaFactor

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: ENT:FareQuotaFactor:SomeFareQuota4

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: FareQuotaFactor

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

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

compatibleWithVersionRef

string · readOnly

Compatible with version.

derivedFromVersionRef

string · readOnly

Derived from version.

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

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

numberOfUnits

integer · int32

The number of units.

Fare prices for the fare quota factor.

Gives a sequence of conditions for validity.

value

string

The value of fare quota factor.

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

FareSection

A Fare section.

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

id

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

Id

Example: NSB:FareSection:TrondheimOslo

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: FareSection

status

string · enum · readOnly · 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

Description

Fare frame ref.

Fare frame ref.

Name

Fare frame ref.

FareStructureElement

A element describing the response structure of the fare

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

fare table reference

VersionOfObjectRef[] · required

geographical interval sequence

VersionOfObjectRef[] · required

geographical structure factor refs

id

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

Id.

Example: NSB:FareStructureElement:TENInterval

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: FareStructureElement

GenericParameterAssignment[] · required

Access Right Parameter assignments.

VersionOfObjectRef[] · required

quality structure factor refs

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

ValidityConditions sequence.

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

Description.

A LimitingRule

Name.

organisationId

string · readOnly

Organisation related to the userProfile

Fare prices.

tariffBasis

string · enum

Tariff basis.

Enum values:

FLAT

DISTANCE

UNIT_SECTION

ZONE

ZONE_TO_ZONE

POINT_TO_POINT

ROUTE

TOUR

Example: DISTANCE

version

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

Version.

Example: NSB:Version:V1

FareStructureElementInSequence

A description of a fare structure element in sequence

accessNumber

integer · int32 · required

The actual ordering in the sequence

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

fareStructureElementId

string · required

Fare structure element ref

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:FareStructureElementInSequence:MiniPriceTENInterval

nameOfClass

string · required

Name of class.

Example: FareStructureElementInSequence

version

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

Fare structure element in sequence version.

Example: NSB:Version:V1

Description.

isFirstInSequence

boolean

Gives information if this sequence first or not

isLastInSequence

boolean

Gives information if this sequence last or not

limitedAccessNumber

integer · int32

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

Name.

orderOfElement

integer · int32

Access quality structure factor refs

FareStructureElementInSequenceInsert

VersionOfObjectRef · required

Fare frame ref.

fareStructureElementId

string · required

Fare structure element id

Example: NSB:FareStructureElement:TENInterval

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

accessNumber

integer · int32

The actual access number

Description.

isFirstInSequence

boolean

Whether element is first in sequence

isLastInSequence

boolean

Whether element is last in sequence

limitedAccessNumber

integer · int32

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

Name.

orderOfElement

integer · int32

Access quality structure factor refs

FareStructureElementInsert

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

fare table reference

VersionOfObjectRef[] · required

geographical interval sequence

id

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

Id.

Example: NSB:FareStructureElement:TENInterval

VersionOfObjectRef[] · required

Access Right Parameter assignments.

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

Description.

geographicalStructureFactorId

string

Geographical structure factor id

Example: NSB:GeographicalStructureFactor:TENPrices

Name.

Fare prices.

tariffBasis

string · enum

Tariff basis.

Enum values:

FLAT

DISTANCE

UNIT_SECTION

ZONE

ZONE_TO_ZONE

POINT_TO_POINT

ROUTE

TOUR

Example: DISTANCE

version

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

Version.

Example: NSB:Version:V1

FareStructureElementPageWrapper

FareTablePageWrapper

FareStructureElement[] · readOnly · required

Fare structure elements for the given page

requestedPageNumber

integer · int32 · required

Number of the requested page. In case state is lost

Example: 369

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

FareTable

A FareTable

Cell[] · required

Cell

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:FareTable:Ordinary

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: FareTable

FarePrice[] · required

FarePrice.

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

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

Description.

endDate

string · date

EndDate.

Example: 2017-11-11

Name.

organisationId

string · readOnly

Organisation related to the fare table

startDate

string · date

StartDate.

Example: 2017-11-11

FareTableInsert

VersionOfObjectRef · required

Fare frame ref.

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

CellInsert[]

Cell

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

Description.

endDate

string · date

EndDate.

FarePrice.

startDate

string · date

StartDate.

Fare frame ref.

FareTablePageWrapper

FareTable[] · readOnly · required

Fare Tables for the given page

requestedPageNumber

integer · int32 · required

Number of the requested page. In case state is lost

Example: 369

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

FareTableRef

nameOfRefClass

string

ref

string

version

string

FrequencyOfUse

Frequency of use

changed

string · date-time · required

Frequency of use changed datetime.

created

string · date-time · required

Frequency of use created datetime.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References for associated fare tables.

id

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

Id.

Example: NSB:FrequencyOfUse:Single

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: FrequencyOfUse

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

Frequency of use version.

Example: NSB:Version:V1

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

frequencyOfUseType

string · enum

Frequency of use type.

Enum values:

NONE

SINGLE

LIMITED

UNLIMITED

TWICE_A_DAY

Example: SINGLE

maximalFrequency

integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency

integer · int32

Minimal frequency given for this frequency of use.

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

Prices in different currencies for the refunding rule.

FrequencyOfUseInsert

VersionOfObjectRef · required

Fare frame ref.

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

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

References for associated fare tables.

frequencyOfUseType

string · enum

Frequency of use type.

Enum values:

NONE

SINGLE

LIMITED

UNLIMITED

TWICE_A_DAY

Example: SINGLE

maximalFrequency

integer · int32

Maximal frequency given for this frequency of use.

minimalFrequency

integer · int32

Minimal frequency given for this frequency of use.

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

Prices in different currencies for the frequency of use.

FulfilmentMethod

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

TextInLanguage[] · required

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

VersionOfObjectRef · required

Fare frame ref.

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

VersionOfObjectRef[] · required

Reference to TYPEs OF TRAVEL DOCUMENT allowed by method.

version

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

Version.

Example: NSB:Version:V1

fulfilmentMethodType

string · enum

Type of fulfilment method.

Enum values:

TICKET_OFFICE

TICKET_MACHINE

CONDUCTOR

AGENT

POST

SELFPRINT

SMS

TOP_UP_DEVICE

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly

Name of class.

Example: FulfilmentMethod

requiresBookingReference

boolean

Whether collecting ticket requires booking reference.

requiresCard

boolean

Whether collecting ticket requires credit card used to purchase.

GeneralGroupOfEntities

General Group of Entities.

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: ENT:GeneralGroupOfEntities:SomeId

VersionOfObjectRef[] · required

Member refs.

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: GeneralGroupOfEntities

nameOfMemberClass

string · required

Name of member class

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

GeneralGroupOfEntities version.

Example: ENT:Version:SomeVersion

compatibleWithVersionRef

string · readOnly

Compatible with version.

derivedFromVersionRef

string · readOnly

Derived from version.

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

GeneralGroupOfEntities Name 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.

GenericParameterAssignment

A GenericParameterAssignment

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:GenericParameterAssignment:AllowedOperators

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class

Example: GenericParameterAssignment

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:V2

canIgnoreInOffering

boolean

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

Example: true

chargingBasisType

string · enum

ChargingBasisType.

Enum values:

FREE

DISCOUNTED

NORMAL

ANY

Example: FREE

comparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

compatibleWithVersionRef

string

CompatibleWithVersionRef.

Example: NSB:Version:V1

derivedFromVersionRef

string

Derived from version.

Example: NSB:Version:V1

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

Fare frame ref.

Fare frame ref.

Includes genericParameterAssignments.

includesGroupingType

string · enum

Includes grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

limitationGroupingType

string · enum

Limitation grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

Limitations as UsageParameters.

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

Fare frame ref.

requiredElements

string[]

Required elements.

requiredInContext

string · enum

Required in context.

Enum values:

OFFERING

BOOKING

RESERVATION

SALE

FULFILMENT

ACTIVATION

CONSUMPTION

REVALIDATION

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

TemporalValidityParameter[]

Fare frame ref.

Temporal validity parameter.

TypeOfAccessRightAssignment

A classification of Access Right Assignments.

Fare frame ref.

validityParameterAssignmentType

string · enum

Validity parameter assignment type.

Enum values:

EQ

NE

GT

LT

GE

LE

Example: EQ

validityParameterGroupingType

string · enum

Validity parameter grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

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

ScopingValidityParameter[]

Validity parameters as scoping validity parameters

GenericParameterAssignmentInsert

VersionOfObjectRef · required

Fare frame ref.

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

canIgnoreInOffering

boolean

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

Example: true

chargingBasisType

string · enum

ChargingBasisType.

Enum values:

FREE

DISCOUNTED

NORMAL

ANY

Example: FREE

comparisonOperatorVariant

string

Deprecated: this parameter is ignored.

Example: E

compatibleWithVersionRef

string

CompatibleWithVersionRef.

Example: NSB:Version:V1

derivedFromVersionRef

string

Derived from version.

Example: NSB:Version:V1

Fare frame ref.

GenericParameterAssignmentInsert[]

Fare frame ref.

Includes genericParameterAssignments.

includesGroupingType

string · enum

Includes grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

limitationGroupingType

string · enum

Limitation grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

Limitations as UsageParameters.

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

requiredInContext

string · enum

Required in context.

Enum values:

OFFERING

BOOKING

RESERVATION

SALE

FULFILMENT

ACTIVATION

CONSUMPTION

REVALIDATION

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

TemporalValidityParameterInsert[]

Fare frame ref.

Temporal Validity parameter.

TypeOfAccessRightAssignment

A classification of Access Right Assignments.

ScopingValidityParameterInsert[]

Fare frame ref.

validityParameterAssignmentType

string · enum

Validity parameter assignment type.

Enum values:

EQ

NE

GT

LT

GE

LE

Example: EQ

validityParameterGroupingType

string · enum

Validity parameter grouping type.

Enum values:

AND

OR

XOR

NOT

Example: AND

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

Validity parameters as scoping validity parameters

GeographicalInterval

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

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

version

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

Version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

endGeographicalValue

integer · int64

endGeographicalValue.

Reference to fare table.

intervalType

string · enum

intervalType.

Enum values:

STOP

TARIFF_ZONE

DISTANCE

COUPON

OTHER

A LimitingRule

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly

Name of class.

Example: GeographicalInterval

numberOfUnits

number · double

numberOfUnits.

Prices for the fare.

startGeographicalValue

integer · int64

startGeographicalValue.

validityConditions.

GeographicalIntervalInsert

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

Reference to fare table.

id

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

Id.

Example: NSB:GeographicalInterval:1364TEN

FarePriceInsert[] · required

Prices for the fare.

endGeographicalValue

integer · int64

EndGeographicalValue.

intervalType

string · enum

IntervalType.

Enum values:

STOP

TARIFF_ZONE

DISTANCE

COUPON

OTHER

numberOfUnits

number · double

NumberOfUnits.

startGeographicalValue

integer · int64

StartGeographicalValue.

version

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

Version.

Example: NSB:Version:V1

GeographicalStructureFactor

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

TextInLanguage[] · required

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

DistanceMatrixElement[] · required

Distance matrix elements

VersionOfObjectRef · required

Fare frame ref.

GeographicalInterval[] · required

Geographical intervals

id

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

Id

Example: NSB:GeographicalStructureFactor:50TEN

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[] · required

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

nameOfClass

string · readOnly · required

Name of class

Example: GeographicalStructureFactor

status

string · enum · readOnly · 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

geographicalUnitRef

string

Geographical unit ref

GroupOfDistanceMatrixElements

A GroupfOfDistanceMatrixElemenets

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:GroupOfDistanceMatrixElements:TENDistances

membersId

string · required

DistanceMatrixElements within the group.

nameOfClass

string · required

Name of class.

Example: GroupOfDistanceMatrixElements

version

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

GroupOfDistanceMatrixElements version.

Example: NSB:Version:V1

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

fareFrameId

integer · int64

Fare frame id.

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

tariffId

integer · int64

Tariff id.

Validity conditions for the user profile.

GroupOfDistanceMatrixElementsInsert

A GroupDistanceMatrixElement create request

VersionOfObjectRef · required

Fare frame ref.

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

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

fareFrameId

integer · int64

Fare frame id.

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

tariffId

integer · int64

Tariff id.

Validity conditions for the user profile.

GroupOfTimeBands

A GroupOfTimeband describe during which the assignments applies

changed

string · required

Changed datetime.

created

string · required

Created datetime.

id

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

Id.

Timeband[] · required

Members.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: FareStructureElement

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

ValidityConditions sequence.

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

version

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

Version.

Example: NSB:Version:V1

GroupTicket

A GroupTicket

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:GroupTicket:FamilyDiscount

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: GroupTicket

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

The version of the group ticket.

Example: NSB:Version:V1

CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

References to fare tables that provide prices or discounts for the 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

jointCheckIn

string · enum

jointCheckIn

Enum values:

NONE

ALLOWED

REQUIRED

Fare frame ref.

maximumNumberOfPersons

integer · int32

maximumNumberOfPersons

minimumNumberOfPersons

integer · int32

minimumNumberOfPersons

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

Fare prices for the group ticket.

pricingBasis

string · enum

Price basis

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

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

typeOfUsageParameter

string

typeOfUsageParameter.

Validity conditions for the group ticket.

GroupTicketInsert

A group ticket create request

VersionOfObjectRef · required

Fare frame ref.

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

CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

groupDiscountBasis

string · enum

groupDiscountBasis

Enum values:

FREE

DISCOUNT_FOR_ALL

DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP

STEP_DISCOUNT

DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS

jointCheckIn

string · enum

jointCheckIn

Enum values:

NONE

ALLOWED

REQUIRED

maximumNumberOfPersons

integer · int32

maximumNumberOfPersons

minimumNumberOfPersons

integer · int32

minimumNumberOfPersons

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

Fare prices for the group ticket.

pricingBasis

string · enum

Price basis

Enum values:

PER_OFFER

PER_PERSON

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

typeOfUsageParameter

string

typeOfUsageParameter.

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.

Interchanging

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Interchanging:Trondelag

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Interchanging

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

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

Description.

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

Name.

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

Fare frame ref.

InterchangingInsert

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Interchanging:Trondelag

TextInLanguage[] · required

Name.

Description.

fromMode

string · enum

Vehicle fromMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

maximumNumberOfChanges

integer · int32

MaximumNumberOfChanges.

maximumTimeToMakeATransfer

string

MaximumTimeToMakeATransfer

toMode

string · enum

Vehicle toMode.

Enum values:

AIR

BUS

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

METRO

Fare frame ref.

version

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

Version.

Example: NSB:Version:V1

JourneyPattern

A Journey Pattern

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

id

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

Id

Example: NSB:JourneyPattern:TrondheimOslo

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: FareSection

status

string · enum · readOnly · 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

Description

FarePointInPattern[]

Fare points in pattern. Versioned child of JourneyPattern

Name

LimitingRule

A LimitingRule

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: LimitingRule

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

canBeCumulative

boolean

CanBeCumulative.

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

Description.

discountAsPercentage

number · float

DiscountAsPercentage.

discountAsValue

number · float

DiscountAsValue.

maximumPrice

string

MaximumPrice.

Example: 164.0

maximumPriceAsPercentage

number · double

MaximumPriceAsPercentage.

minimumLimitPrice

string

MinimumLimitPrice.

Example: 164.0

minimumPrice

string

MinimumPrice.

Example: 164.0

Name.

version

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

Version.

Example: NSB:Version:V1

ListTextInLanguage

empty

boolean

traversableAgain

boolean

LuggageAllowance

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

TextInLanguage[] · required

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

VersionOfObjectRef · required

Fare frame ref.

id

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

Id

Example: NSB:LuggageAllowance:Bicycle

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[] · required

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

nameOfClass

string · readOnly · required

Name of class

Example: LuggageAllowance

status

string · enum · readOnly · 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

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

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

organisationId

string

Organisation related to the userProfile

Prices for the luggage allowance.

MapStringObject

empty

boolean

traversableAgain

boolean

Metadata

created

string · readOnly · required

Created datetime

id

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

Id

Example: NSB:SalesPackage:Ordinary

nameOfClass

string · readOnly · required

Name of class.

Example: JourneyPattern

responsible

string · minLength: 1 · required

Responsible

Example: Kari Nordmann

version

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

Version

Example: NSB:Version:V1

externalReferenceName

string

External reference name

externalReferenceUrl

string

External reference URL

note

string

Note

Example: Dette er en endring

MininmalVersionInfo

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

string · readOnly · required

Id.

Example: NSB:ElementTypeMetadata:Test

nameOfClass

string · readOnly · required

Name of class.

Example: ElementTypeMetadata

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · readOnly · required

Version

Example: NSB:Version:V1

endDate

string · date-time · readOnly

EndDate

TextInLanguage[] · readOnly

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

startDate

string · date-time · readOnly

StartDate

NameAndDescription

TextInLanguage[] · required

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

TextInLanguage[] · required

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

OnboardStay

An OnboardStay

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

id

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

Id.

Example: NSB:OnboardStay:Sleeper

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: OnboardStay

status

string · enum · readOnly · 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

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

ParameterPossibilitiesRequest

Request for retrieving refunding alternatives for elements.

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

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

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

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

PenaltyPolicy

A PENALTY POLICY

changed

string · readOnly · required

Changed

created

string · readOnly · required

Created

VersionOfObjectRef[] · required

References for associated fare tables.

id

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

Id

Example: NSB:PenaltyPolicy:InspectionFeeYoung

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

NameOfClass

Example: PenaltyPolicy

status

string · enum · readOnly · 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

compatibleWithVersionRef

string

CompatibleWithVersionRef

derivedFromVersionRef

string

Derived from version.

Description.

Fare frame ref.

A LimitingRule

Fare frame ref.

minimumTimeBeforeReentry

string

MinimumTimeBeforeReentry

Example: PT24H

Name.

paymentMethod

string

PaymentMethod

Example: CASH

penaltyAction

string

PenaltyAction

Example: FINE

penaltyPolicyType

string

PenaltyPolicyType

Example: NO_TICKET

Prices in different currencies for the penalty policy.

sameStationReentryPolicyType

string

SameStationReentryPolicyType

Example: BLOCKED

typeOfUsageParameterRef

string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

PenaltyPolicyAlternatives

Penalty policy alternatives for an element.

PenaltyPolicy[] · required

Penalty policy alternatives for this element.

IdAndVersion · required

Describes the ID and version of an element.

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

Limitations as UsageParameters.

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

organisation

string

Organisation who own the product.

version

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

Version.

Example: NSB:Version:V1

PreassignedFareProduct

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

GenericParameterAssignment[] · required

AccessRightParameterAssignments.

AccessRightInProduct[] · required

AccessRightsInProduct.

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: PreassignedFareProduct

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

ValidityCondition.

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

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string

CompatibleWithVersionRef.

A summary of a condition.

derivedFromVersionRef

string

Derived from version.

Description.

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

FareTableRef.

Fare frame ref.

Name.

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

organisation

string

Organisation who own the product.

organisationId

string

Organisation related to the userProfile

Fare prices.

privateCode

string

PrivateCode.

productType

string · enum

The type of fare product.

Enum values:

SINGLE_TRIP

TIME_LIMITED_SINGLE_TRIP

PERIOD_PASS

Example: SINGLE_TRIP

A classification of FARE PRODUCTs.

version

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

Version.

Example: NSB:Version:V1

PreassignedFareProductInsert

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

TextInLanguage[] · required

Name.

operatorRef

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

OperatorRef.

Example: RUT:Authority:RUT

organisation

string · required

Organisation.

version

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

Version.

Example: NSB:Version:V1

AccessRightInProductInsert[]

AccessRightParameterAssignments.

AccessRightsInProduct.

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string

Compatible with version.

ConditionSummaryInsert

ConditionSummary.

derivedFromVersionRef

string

Derived from version.

Description.

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

FareTableRef.

Fare prices.

privateCode

string

PrivateCode.

productType

string · enum

The type of fare product.

Enum values:

SINGLE_TRIP

Example: SINGLE_TRIP

Fare frame ref.

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

PreassignedFareProductPageWrapper

PreassignedFareProductWrapper

PreassignedFareProduct[] · readOnly · required

Preassigned fare products for the given page

requestedPageNumber

integer · int32 · required

Requested page number.

Example: 1

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

PricingParameterSet

changed

string · date-time · required

Changed datetime.

compatibleWithVersionRef

string · required

Compatible with version.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:PricingParameterSet:123abc

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: TypeOfUsageParameter

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

derivedFromVersionRef

string

Derived from version.

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

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

PricingRuleEntity[]

Different rules that is common for the operator

PricingRuleEntity

ListTextInLanguage

Fare frame ref.

id

string

ListTextInLanguage

version

string

ProblemDetail

detail

string

instance

string · uri

object

status

integer · int32

title

string

type

string · uri

ProductTreeExplained

Schema for presenting explained messages for failed product trees

TextInLanguage[] · required

Description of the root 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

TextInLanguage[] · required

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

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

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

version

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

Version for root component/element

Example: NSB:Version:V1

explainedElementId

string · readOnly

The netexId of the explained element

explainedElementNameOfClass

string · readOnly

The nameOfClass of the explained element

explainedElementVersion

string · readOnly

The version of the explained element

SeqExplainedMessageResponse · readOnly

Translated messages explaining the failure

nameOfClass

string · minLength: 1 · readOnly

nameOfClass

Example: SalesPackage

originalErrorMessage

string · readOnly

The original error message thrown

reason

string · readOnly

Reason for failed tree

Example: invalidProductData

PropertyOfDay

The DayType describe during which the assignment applies

countryRef

string · readOnly · required

Reference to country for holiday. ISO 3166-1

Example: NO

name

string · required

Name of property of day

Example: Monday

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

holidayTypes

string[]

Holiday types

monthOfYear

integer · enum · int32

Month of year

Enum values:

1

2

3

4

5

6

7

8

PurchaseWindow

A PurchaseWindow

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:PurchaseWindow:Child

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: PurchaseWindow

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

PurchaseWindow version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

latestTime

string

Latest time to purchase.

Example: 23:59:59.999999999

A LimitingRule

maxmumPeriodBeforeDeparture

string

Maximum period before departure.

Example: 23:59:59.999999999

minimumPeriodBeforeDeparture

string

Minimum period before departure.

Example: 01:59:59.999999999

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

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

PurchaseWindowInsert

VersionOfObjectRef · required

Fare frame ref.

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

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

latestTime

string

Latest time.

Example: 23:59:59

A LimitingRule

maxmumPeriodBeforeDeparture

string

Maximum period before departure.

Example: PT2160H

minimumPeriodBeforeDeparture

string

Minimum period before departure.

Example: PT2160H

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

Refunding

allowed

string · enum · required

Allowed.

Enum values:

NONE

PARTIAL

FULL

Example: FULL

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References for associated fare tables.

id

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

Id.

Example: NSB:Refunding:FullRefundUntilLimit

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Refunding

status

string · enum · required

Refunding status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Refunding version.

Example: NSB:Version:V1

canChangeClass

boolean

Whether user can change class.

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

exchangeableFromDuration

string

Exchangeable from duration.

Example: PT24H

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration

string

Exchangeable until duration.

hasFee

boolean

Has fee.

limitingRule

string

Pricing rule.

Fare frame ref.

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

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

Prices in different currencies for the refunding rule.

refundBasis

string · enum

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

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

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

unusedTicketsOnly

boolean

Unused tickets only.

RefundingAlternatives

Refunding alternatives for an element.

IdAndVersion · required

Describes the ID and version of an element.

Refunding[] · required

Refunding alternatives for this element.

RefundingInsert

allowed

string · enum · required

Allowed.

Enum values:

NONE

PARTIAL

FULL

Example: FULL

VersionOfObjectRef · required

Fare frame ref.

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.

version

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

UsageValidityPeriod version.

Example: NSB:Version:V1

canChangeClass

boolean

Whether user can change class.

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

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.

hasFee

boolean

Has fee.

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

Prices in different currencies for the refunding rule.

refundBasis

string · enum

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

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

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

unusedTicketsOnly

boolean

Unused tickets only.

Replacing

A Replacing

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References for associated fare table.

id

string · minLength: 1 · required

Id.

Example: NSB:Replacing:SomeId

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: Replacing

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · minLength: 1 · required

The version of the replacing.

Example: ENT:Version:SomeVersion

allowed

string · enum

Allowed.

Enum values:

NONE

PARTIAL

FULL

canChangeClass

boolean

Whether user can change class.

compatibleWithVersionRef

string · readOnly

Compatible with version.

derivedFromVersionRef

string · readOnly

Derived from version.

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

exchangeableFromAnyTime

boolean

Can be exchanged or refunded from any point after purchase.

exchangeableFromDuration

string

Exchangeable from duration.

Example: PT24H

exchangeableUntilAnyTime

boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration

string

Exchangeable until duration.

hasFee

boolean

Has fee.

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

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

Fare prices for the replacing.

refundBasis

string · enum

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

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

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

typeOfUsageParameter

string

typeOfUsageParameter.

unusedTicketsOnly

boolean

Unused tickets only.

Gives a sequence of conditions for validity.

Reserving

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References for associated fare tables.

id

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

Id.

Example: NSB:Reserving:SeatAsAccommodationReserving

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Reserving

status

string · enum · required

Reserving status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Reserving version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

feeBasis

string · enum

Fee basis.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

A LimitingRule

Fare frame ref.

maximumNumberToReserve

integer · int32

Maximum amount to reserve.

minimumNumberToReserve

integer · int32

Minimum amount to reserve.

mustReserveWholeCompartment

boolean

Must reserve whole compartment

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

Prices in different currencies for the reserving rule.

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

typeOfUsageParameter

string

Type of usage parameter for the reservation.

Example: NSB:TypeOfUsageParameter:OpenSeating

ReservingInsert

VersionOfObjectRef · required

Fare frame ref.

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

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

feeBasis

string · enum

Fee basis.

Enum values:

PER_OFFER

PER_PERSON

Example: PER_OFFER

maximumNumberToReserve

integer · int32

Maximum amount to reserve.

minimumNumberToReserve

integer · int32

Minimum amount to reserve.

mustReserveWholeCompartment

boolean

Must reserve whole compartment

Prices for the reserving.

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

typeOfUsageParameter

string

Type of usage parameter for the reservation.

Example: NSB:TypeOfUsageParameter:ThroughFareInterchanging

Reverting

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

string · minLength: 1 · required

Id.

Example: NSB:Reverting:SelfService

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: Reverting

status

string · enum · readOnly · required

Reverting status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · minLength: 1 · required

Reverting version.

Example: NSB:Version:V1

allowedAfterControl

boolean

Specifies if revert is allowed after control.

Example: true

Default: false

compatibleWithVersionRef

string · readOnly

Compatible with version.

derivedFromVersionRef

string · readOnly

Derived from version.

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

References for associated fare tables.

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

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

Prices in different currencies for the reverting rule.

Fare frame ref.

typeOfUsageParameter

string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

RoundTrip

A RoundTrip

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

doubleSingleFare

boolean · required

Double single fare

Example: true

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:RoundTrip:Child

isRequired

boolean · required

Is required.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: RoundTrip

shortTrip

boolean · required

Short trip

Example: true

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

RoundTrip version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

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

Fare frame ref.

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

Fare prices for the round trip.

required

boolean

tripType

string · enum

Type of round trip

Enum values:

SINGLE

RETURN

RETURN_ONLY

MULTIPLE

typeOfUsageParameter

string

typeOfUsageParameter.

Validity conditions for the round trip.

RoundTripInsert

A RoundTrip create request

doubleSingleFare

boolean · required

Double single fare

Example: true

VersionOfObjectRef · required

Fare frame ref.

id

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

Id

Example: NSB:RoundTrip:Child

isRequired

boolean · required

Is required.

TextInLanguage[] · required

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

shortTrip

boolean · required

Short trip

Example: true

version

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

Round trip version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

Example: NSB:Version:V1

derivedFromVersionRef

string

Derived from version.

Example: NSB:Version:V1

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

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

Fare frame ref.

Fare prices for the round trip.

required

boolean

tripType

string · enum

Type of round trip

Enum values:

SINGLE

RETURN

RETURN_ONLY

MULTIPLE

typeOfUsageParameter

string

typeOfUsageParameter.

Validity conditions for the round trip.

Rounding

A description of how prices are rounded post calculation

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Rounding:Ordinary

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: Rounding

roundingMethod

string · enum · required

Type of rounding.

Enum values:

NONE

DOWN

UP

SPLIT

STEP_TABLE

FIVE

NINE

TEN

status

string · enum · readOnly · required

Rounding status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Rounding version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

Description.

Name.

roundingModulus

number · double

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

RoundingInsert

Rounding.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Rounding:Ordinary

roundingMethod

string · enum · required

Type of rounding.

Enum values:

NONE

DOWN

UP

SPLIT

STEP_TABLE

FIVE

NINE

TEN

version

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

Rounding version.

Example: NSB:Version:V1

Description.

Name.

roundingModulus

number · double

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

SaleDiscountRight

A Sale Discount Right response

GenericParameterAssignment[] · required

AccessRightParameterAssignments.

AccessRightInProduct[] · required

AccessRightsInProduct.

changed

string · readOnly · required

SalesPackage changed datetime.

created

string · readOnly · required

SalesPackage create datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[] · required

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

nameOfClass

string · readOnly · required

Name of class.

Example: PreassignedFareProduct

organisation

string · required

Organisation who own the product.

FarePrice[] · required

Prices for the sdr.

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

ValidityCondition.

version

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

Version

Example: NSB:Version:V1

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string · readOnly

CompatibleWithVersionRef

A summary of a condition.

derivedFromVersionRef

string · readOnly

Derived from version.

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

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

FareTableRef.

Fare frame ref.

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

organisationId

string

Organisation related to the userProfile

privateCode

string

PrivateCode.

A classification of FARE PRODUCTs.

Fare frame ref.

validationRequirements

string[]

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

SaleDiscountRightPageWrapper

SeqSaleDiscountRight[] · readOnly · required

SaleDiscountRights for the given page

requestedPageNumber

integer · int32 · readOnly · required

Number of the requested page. In case state is lost

Example: 13

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

SalesPackage

A SalesPackage response

GenericParameterAssignment[] · required

Access Right Parameter assignments.

changed

string · required

SalesPackage changed datetime.

created

string · required

SalesPackage create datetime.

DistributionAssignment[] · required

Distribution assignments.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References to fare tables.

id

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

Id.

Example: NSB:SalesPackage:Ordinary

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: SalesPackage

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

compatibleWithVersionRef

string

CompatibleWithVersionRef

derivedFromVersionRef

string

Derived from version.

Description.

A LimitingRule

Fare frame ref.

SalesPackage Name.

Fare prices.

SalesPackageElement[]

Sales package elements.

vatGroupRegister

string · enum

VatGroupRegister is optional. No default value

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

version

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

Version

Example: NSB:Version:V1

SalesPackageElement

A SalesPackageElement

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References to fare tables.

id

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

Id.

Example: NSB:SalesPackageElement:Ordinary

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: SalesPackageElement

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

compatibleWithVersionRef

string

CompatibleWithVersionRef.

derivedFromVersionRef

string

Derived from version.

Description.

Fare frame ref.

A LimitingRule

Fare frame ref.

Name.

Fare frame ref.

Fare frame ref.

SalesPackageElementInsert

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References to fare tables.

id

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

Id.

Example: NSB:SalesPackageElement:Ordinary

TextInLanguage[] · required

Name.

compatibleWithVersionRef

string

CompatibleWithVersionRef

derivedFromVersionRef

string

Derived from version.

Description.

Fare frame ref.

A LimitingRule

Fare frame ref.

Fare frame ref.

version

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

Version

Example: NSB:Version:V1

SalesPackageInsert

VersionOfObjectRef[] · required

AccessRightParameterAssignments.

DistributionAssignmentInsert[] · required

Distribution assignments.

VersionOfObjectRef · required

Fare frame ref.

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

activeComparisonOperatorVariant

string

Deprecated: this parameter is ignored.

Example: E

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

References to fare tables.

SalesPackageElementInsert[]

Fare prices.

Sales package elements.

vatGroupRegister

string · enum

VatGroupRegister is optional. No default

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

SalesPackagePageWrapper

v2.SalesPackage[] · readOnly · required

SalesPackages for the given page

requestedPageNumber

integer · int32 · readOnly · required

Number of the requested page. In case state is lost

Example: 13

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

ScopingValidityParameter

A ScopingValidityParameter

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:ScopingValidityParameter:OperatorNSB

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: ScopingValidityParameter

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

authorityRef

string

AuthorityRef.

Example: NSB:Authority:NSB

compatibleWithVersionRef

string

CompatibleWithVersionRef.

derivedFromVersionRef

string

Derived from version.

distributionChannelRef

string

Distribution channel ref.

Example: ENT:DistributionChannel:App

facilitySetRef

string

facilitySetRef.

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

fareSectionRef

string

Fare section ref.

fareZoneRef

string

FareZoneRef.

Example: KOL:FareZone:250

groupOfLinesRef

string

Group of Lines ref.

Example: ENT:GroupOfLines:AllLines

groupOfTariffZonesRef

string

Group of Tariff Zones ref.

Example: ENT:GroupOfTariffZones:AllZones

lineRef

string

LineRef.

lineType

string · enum

LineType.

Enum values:

LOCAL

URBAN

LONG_DISTANCE

EXPRESS

SEASONAL

REPLACEMENT

FLEXIBLE

CORRIDOR_SERVICE

Example: EXPRESS

operatorRef

string

Operator referance.

placeUse

string · enum

PlaceUse

Enum values:

START_AT

END_AT

VIA

RESTRICT_TO

OTHER

scheduledStopPointRef

string

Scheduled stop Point ref.

topographicPlaceRef

string

TopographicPlaceRef

transportSubmode

string · enum

TransportSubmode.

Enum values:

unknown

undefined

internationalFlight

domesticFlight

intercontinentalFlight

domesticScheduledFlight

shuttleFlight

intercontinentalCharterFlight

Example: expressBus

vehicleMode

string · enum

VehicleModeRef.

Enum values:

AIR

BUS

COACH

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

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

authorityRef

string

AuthorityRef.

Example: NSB:Authority:NSB

changed

string · date-time

compatibleWithVersionRef

string

CompatibleWithVersionRef

created

string · date-time

derivedFromVersionRef

string

Derived from version.

distributionChannelRef

string

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

Example: ENT:DistributionChannel:App

facilitySetRef

string

facilitySetRef.

fareClasses

string[]

Fare class list.

fareSectionRef

string

Fare section ref.

fareZoneRef

string

FareZoneRef.

Example: KOL:FareZone:250

groupOfLinesRef

string

Group of lines ref.

Example: ENT:GroupOfLines:AllLines

groupOfTariffZonesRef

string

Group of Tariff Zones ref

Example: ENT:GroupOfTariffZones:AllZones

lineRef

string

LineRef.

lineType

string · enum

LineType.

Enum values:

LOCAL

URBAN

LONG_DISTANCE

EXPRESS

SEASONAL

REPLACEMENT

FLEXIBLE

CORRIDOR_SERVICE

Example: EXPRESS

nameOfClass

string

operatorRef

string

Operator referance.

placeUse

string · enum

PlaceUse

Enum values:

START_AT

END_AT

VIA

RESTRICT_TO

OTHER

scheduledStopPointRef

string

Scheduled stop Point ref.

topographicPlaceRef

string

TopographicPlaceRef

transportSubmode

string · enum

TransportSubmode.

Enum values:

unknown

undefined

internationalFlight

domesticFlight

intercontinentalFlight

domesticScheduledFlight

shuttleFlight

intercontinentalCharterFlight

Example: expressBus

vehicleMode

string · enum

VehicleModeRef.

Enum values:

AIR

BUS

COACH

CABLE_WAY

WATER

FUNICULAR

LIFT

RAIL

SecurityPolicy

changed

string · readOnly · required

Changed

created

string · readOnly · required

Created

id

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

Id

Example: NSB:SecurityPolicy:HighValueProduct

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.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

NameOfClass

Example: SecurityPolicy

status

string · enum · readOnly · 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

Description.

Fare frame ref.

Name.

SeqExplainedMessageResponse

Translated messages explaining the failure

empty

boolean

traversableAgain

boolean

SeqGeographicalIntervalInsert

empty

boolean

traversableAgain

boolean

SeqSaleDiscountRight

empty

boolean

traversableAgain

boolean

SeqStatusFilterEnum

empty

boolean

traversableAgain

boolean

SeqUVPForNumberOfZonesInsert

empty

boolean

traversableAgain

boolean

SeqUsageValidityPeriodInsert

empty

boolean

traversableAgain

boolean

ServiceFacilitySet

A ServiceFacilitySet

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

id

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

Id

Example: NSB:ServiceFacilitySet:Ordinary

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: ServiceFacilitySet

status

string · enum · readOnly · 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

Accommodation

An Accommodation

Description

Name

OnboardStay

An OnboardStay

SetString

empty

boolean

traversableAgain

boolean

SteppedDuration

Stepped duration.

initialDuration

string · required

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

Example: PT1H

stepUnit

string · enum · required

Step unit.

Enum values:

STOPS

STOPS_INCLUDING_PASS_THROUGH_STOPS

SECTIONS

ZONES

NETWORKS

OPERATORS

COUNTRIES

Example: ZONES

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

SupplementProduct

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

GenericParameterAssignment[] · required

accessRightParameterAssignments.

AccessRightInProduct[] · required

accessRightParameterAssignments.

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

fareProductRef.

VersionOfObjectRef[] · required

Reference to information about the fare.

id

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

Id.

Example: NSB:SupplementProduct:BicycleReserving

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: SupplementProduct

organisation

string · required

Organisation.

VersionOfObjectRef · required

Fare frame ref.

status

string · enum · required

Supplement product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

validityConditions.

vatGroup

string · enum · required

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

version

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

Supplement product version.

Example: NSB:Version:V1

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string

Compatible with version.

A summary of a condition.

derivedFromVersionRef

string

Derived from version.

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

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

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

operatorRef

string

The reference to the operator.

Example: RUT:Authority:RUT

organisationId

string

Organisation related to the userProfile

Fare prices.

privateCode

string

Privat code.

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

A classification of FARE PRODUCTs.

SupplementProductInsert

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:SupplementProduct:LargeAnimal

TextInLanguage[] · required

Name.

operatorRef

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

OperatorRef.

Example: RUT:Authority:RUT

organisation

string · minLength: 1 · required

Organisation.

version

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

Version.

Example: NSB:Version:V1

AccessRightInProductInsert[]

AccessRightParameterAssignments.

AccessRightsInProduct.

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

compatibleWithVersionRef

string

Compatible with version.

ConditionSummaryInsert

ConditionSummary.

derivedFromVersionRef

string

Derived from version.

Description.

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

FareTableRef.

Fare prices.

privateCode

string

PrivateCode.

supplementProductType

string · enum

SupplementProductType.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

Example: SEAT_RESERVATION

Fare frame ref.

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

Tariff

A tariff

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Tariff:Ordinary

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: Tariff

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

Tariffs version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

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

organisationId

string

Organisation related to the userProfile

returnFareTwiceSingle

boolean

returnFareTwiceSingle

tariffBasis

string · enum

TariffBasis.

Enum values:

NEW

REVISE

DELETE

Example: NEW

Fare frame ref.

TariffInsert

VersionOfObjectRef · required

Fare frame ref.

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.

VersionOfObjectRef · required

Fare frame ref.

version

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

Tariff version.

Example: NSB:Version:V1

derivedFromVersionRef

string

Derived from version.

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

returnFareTwiceSingle

boolean

returnFareTwiceSingle

tariffBasis

string · enum

TariffBasis.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TemporalValidityParameter

A TemporalValidityParameter

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TemporalValidityParameter:OperatorNSB

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: TemporalValidityParameter

status

string · enum · readOnly · 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

compatibleWithVersionRef

string

CompatibleWithVersionRef

Fare frame ref.

derivedFromVersionRef

string

Derived from version.

GroupOfTimeBands

A GroupOfTimeband describe during which the assignments applies

ValidityCondition

A condition of the validity of the priceable object

Fare frame ref.

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

Fare frame ref.

GroupOfTimeBands

A GroupOfTimeband describe during which the assignments applies

nameOfClass

string

ValidityCondition

A condition of the validity of the priceable object

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.

Timeband

The TimeBand describe during which the assignment applies

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

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

TextInLanguage[] · required

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

endTime

string · required

End time.

Example: 11:11:11

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Timeband:2HoursValidPlus1

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[] · required

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

nameOfClass

string · readOnly · required

Name of class.

Example: TimeBand

startTime

string · required

Start time.

Example: 11:11:11

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

compatibleWithVersionRef

string · readOnly

Compatible with version.

derivedFromVersionRef

string · readOnly

Derived from version.

timeZone

string

Time zone.

Example: Europe/Oslo

Default: Europe/Oslo

ValidityConditions sequence.

version

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

Version.

Example: NSB:Version:V1

Transferability

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:Transferability:NoTransfer

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: Transferability

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Transferability version.

Example: NSB:Version:V1

canTransfer

boolean

Whether ticket can be transferred to someone else.

Example: false

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

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..

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

Prices in different currencies for the transferability rule.

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.

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: TypeOfAccessRightAssignment

status

string · enum · readOnly · required

Type of access right assignment status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Type of access right assignment version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

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

TypeOfConcession

A TypeOfConcession

changed

string · date-time · required

Changed datetime.

compatibleWithVersionRef

string · required

Compatible with version.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TypeOfConcession:Student

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: TypeOfConcession

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

TypeOfConcession version.

Example: NSB:Version:V1

alternativeNames

string

Alternative names for the type of concession

derivedFromVersionRef

string

Derived from version.

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

infolink

string

An URL to more info about the type of concession

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

organisationId

string

Organisation related to the userProfile

privateCode

string

A code to support interoperability with legacy systems

TypeOfConcessionInsert

A TypeOfConcession

VersionOfObjectRef · required

Fare frame ref.

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

alternativeNames

string

Alternative names for the type of concession

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

infolink

string

An URL to more info about the type of concession

privateCode

string

A code to support interoperability with legacy systems

TypeOfFareProduct

A classification of FARE PRODUCTs.

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TypeOfFareProduct:Ordinary

nameOfClass

string · readOnly · required

Name of class.

Example: TypeOfFareProduct

version

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

Type of fare product version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

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

TypeOfFareProductInsert

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TypeOfFareProduct:Ordinary

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

version

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

Type of fare product version.

Example: NSB:Version:V1

TypeOfUsageParameter

changed

string · date-time · required

Changed datetime.

compatibleWithVersionRef

string · required

Compatible with version.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TypeOfUsageParameter:abc123

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: TypeOfUsageParameter

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

derivedFromVersionRef

string

Derived from version.

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

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

TypeOfUsageParameterInsert

VersionOfObjectRef · required

Fare frame ref.

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

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

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

UVPForNumberOfZones

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: RUT:UVPForNumberOfZones:example

nameOfClass

string · required

Name of class.

Example: UVPForNumberOfZones

numberOfZones

integer · int64 · required

Number of zones.

Example: 3

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

usageValidityPeriodId

string · required

Reference to usage validity period.

Example: NSB:UsageValidityPeriod:Child

version

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

Version.

Example: NSB:Version:V1

zoneRange

string

Zone range.

Example: 4:9

UVPForNumberOfZonesInsert

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:UVPForNumberOFZones:123

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

UsageValidityPeriod

A UsageValidityPeriod response

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

FareTableRef[] · required

References to FareTable.

id

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

Id.

Example: NSB:UsageValidityPeriod:Child

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: UsageValidityPeriod

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

UsageValidityPeriod version.

Example: NSB:Version:V1

activationMeans

string[]

Activation Means. Describes how a product can be activated.

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

A LimitingRule

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

standardDuration

string

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

Example: PT1H

SteppedDuration

Stepped duration.

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

usageStartConstraintType

string · enum

Usage start constraint.

Enum values:

VARIABLE

FIXED

FIXED_WINDOW

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

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.

UsageValidityPeriodInsert

VersionOfObjectRef · required

Fare frame ref.

FareTableRef[] · required

References to FareTable.

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

activationMeans

string[]

Activation Means. Describes how a product can be activated.

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

standardDuration

string

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

Example: PT1H

SteppedDuration

Stepped duration.

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.

usageStartConstraintType

string · enum

Usage start constraint.

Enum values:

VARIABLE

FIXED

FIXED_WINDOW

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

usageValidityTypes

string[]

Usage validity type list.

UserProfile

A UserProfile

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:UserProfile:Child

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: UserProfile

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

UserProfile version.

Example: NSB:Version:V1

baseUserProfileRef

string

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

CompanionProfile[]

Companion Profiles in Group Ticket

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

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

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

Fare frame ref.

maxAge

string

Maximum age.

Example: 16

minAge

string

Minimum age.

Example: 4

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

organisationId

string · readOnly

Organisation related to the userProfile

Fare prices for the user profile.

proofOfIdentity

string · enum

proofOfIdentity.

Enum values:

NONE_REQUIRED

PASSPORT

DRIVERS_LICENCE

IDENTITY_DOCUMENT

CREDIT_CARD

MEMBERSHIP_CARD

STUDENT_CARD

LETTER_WITH_ADDRESS

typeOfConcessionRef

string

typeOfConcessionRef.

typeOfUsageParameter

string

typeOfUsageParameter.

userType

string · enum

UserType.

Enum values:

ANYONE

ADULT

CHILD

INFANT

ANIMAL

SENIOR

GUIDE_DOG

YOUTH

Example: CHILD

Validity conditions for the user profile.

UserProfileInsert

A UserProfile create request

VersionOfObjectRef · required

Fare frame ref.

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.

proofOfIdentity

string · enum · required

proofOfIdentity.

Enum values:

NONE_REQUIRED

PASSPORT

DRIVERS_LICENCE

IDENTITY_DOCUMENT

CREDIT_CARD

MEMBERSHIP_CARD

STUDENT_CARD

LETTER_WITH_ADDRESS

version

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

UserProfile version.

Example: NSB:Version:V1

baseUserProfileRef

string

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

CompanionProfileInject[]

Companion profiles describing users who may travel with user.

compatibleWithVersionRef

string

Compatible with version.

Example: NSB:Version:V1

derivedFromVersionRef

string

Derived from version.

Example: NSB:Version:V1

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

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

Fare frame ref.

maxAge

integer · int32

Maximum age.

Example: 16

minAge

integer · int32

Minimum age.

Example: 4

Fare prices for the user profile.

typeOfConcessionRef

string

typeOfConcessionRef.

typeOfUsageParameter

string

typeOfUsageParameter.

userType

string · enum

UserType.

Enum values:

ANYONE

ADULT

CHILD

INFANT

ANIMAL

SENIOR

GUIDE_DOG

YOUTH

Example: CHILD

Validity conditions for the user profile.

ValidBetween

A ValidBetween

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

fromDate

string · required

From Date.

id

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

Id.

Example: NSB:ValidBetween:2018

nameOfClass

string · required

Name of class.

Example: ValidBetween

status

string · enum · readOnly · 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

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

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

organisationId

string

Organisation related to the userProfile

toDate

string

To Date.

List of validityConditions.

ValidBetweenInsert

A ValidBetween create request

VersionOfObjectRef · required

Fare frame ref.

fromDate

string · required

From Date.

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

id

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

Id.

Example: NSB:ValidBetween:2018

toDate

string

To Date.

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

List of validityConditions.

version

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

Version.

Example: NSB:Version:V1

ValidableElement

A ValidationElement

GenericParameterAssignment[] · required

The references to access right parameter assignments.

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

VersionOfObjectRef[] · required

References for associated fare table.

id

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

Id.

Example: NSB:ValidableElement:Ordinary

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: ValidableElement

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

Validable element version.

Example: NSB:Version:V1

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

AreaValidity

Requirements for area validity.

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

FareStructureElementInSequence[]

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

The fare structure elements in sequence

The reference to the fare divided into a sequence.

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

organisationId

string

Organisation related to the userProfile

Fare prices.

pricingRuleRef

string

Pricing rule reference.

Example: unused

Gives a sequence of conditions for validity.

ValidableElementInsert

TextInLanguage[] · required

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

VersionOfObjectRef · required

Fare frame ref.

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

FareStructureElementInSequenceInsert[]

The references to access right parameter assignments.

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

AreaValidity

Requirements for area validity.

Fare structure elements in sequence

The reference to the fare divided into a sequence.

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

Fare prices.

ValidableElementPageWrapper

Validable Element Page Wrapper

ValidableElement[] · readOnly · required

Validable elements for the given page

requestedPageNumber

integer · int32 · required

Number of the requested page. In case state is lost

Example: 1

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

ValidityCondition

A condition of the validity of the priceable object

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

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

Id.

Example: NSB:ValidBetween:2018

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: ValidBetween

status

string · enum · readOnly · 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

fromDate

string

From Date.

toDate

string

To Date.

VatRegister

A case class for vat register.

description

string · minLength: 1 · required

The VAT description

Example: Person transport and tickets in Norway

id

string · minLength: 1 · required

Id.

Example: ENT:VatRegister:SomeId

validFrom

string · minLength: 1 · required

The time and date from which the VAT is valid

vatGroup

string · enum · required

VAT group

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

vatRate

string · minLength: 1 · required

The percentage rate for the VAT

Example: 12.0

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

countryCode

string

Country for which the VAT is 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

organisationId

integer · int64

OrganisationId for the organisation who uses this VAT-specification.

validTo

string

The time and date to which the VAT is valid

vatCode

string

Code for the VAT, used for accounting

Example: 33

Version

A case class for versioning.

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

id

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

Id.

Example: RUT:Version:RuterSingleTicket

modification

string · enum · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: Version

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Default: DRAFT

versionType

string · enum · required

VersionType.

Enum values:

BASELINE

POINT

description

string

Description.

endDate

string · date-time

EndDate

startDate

string · date-time

StartDate

VersionBatchRetrieve

A case class for versioning.

entityIds

string[] · required

entityIds

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

VersionOfObjectRef

Fare frame ref.

nameOfClass

string · minLength: 1 · required

Name of class.

ref

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

The netex id reference to the object.

version

string · required

Version.

v2.DistributionAssignment

allDistributionChannelsRef

boolean · required

Flag for distribution in all channels.

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

distributionRights

string · enum · required

Distribution rights.

Enum values:

NONE

SELL

REFUND

EXCHANGE

INFROM

PRIVATE

OTHER

Example: SELL

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:DistributionAssignment:Ordinary

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: DistributionAssignment

VersionOfObjectRef · required

Fare frame ref.

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.

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · required

Version

Example: NSB:Version:V1

allOrganisationRef

boolean

Flag for all organisations.

allowedInChannel

boolean

Flag for allowed in channel.

allowedInCountry

boolean

Flag for allowed in country.

anyCountryRef

boolean

Flag for allowed in any country.

countryRef

string

Country reference.

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

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

finalCarrier

boolean

Flag for final carrier.

Fare frame ref.

Fare frame ref.

Fare frame ref.

initialCarrier

boolean

Flag for initial carrier.

mandatoryProduct

boolean

Flag for mandatory product.

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

requiresRegistration

boolean

Flag for requires registration.

responsibilitySetRef

string

Responsibility set reference.

restrictedToChannel

boolean

Flag for restricted to channel.

Fare frame ref.

ticketingServices

string[]

Ticketing services.

Enum values:

TSF_PURCHASE

COLLECTION

CARD_TOP_UP

RESERVATIONS

topographicPlaceRef

string

Topographical place reference.

transitCarrier

boolean

Flag for transit carrier.

v2.SalesPackage

SalesPackage

changed

string · readOnly · required

Changed datetime

created

string · readOnly · required

Created datetime

v2.DistributionAssignment[] · required

Distribution assignments.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id

Example: NSB:SalesPackage:Ordinary

modification

string · enum · readOnly · required

Modification status

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class

Example: SalesPackage

status

string · enum · readOnly · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

GenericParameterAssignment[] · required

Validity Parameter assignments.

version

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

Version

Example: NSB:Version:V1

activeComparisonOperatorVariant

string

Deprecated: this parameter will be ignored

Example: E

Description

A LimitingRule

Fare frame ref.

Name

organisationId

string

Organisation related to the userProfile

Fare prices.

SalesPackageElement[]

Sales package elements.

vatGroupRegister

string · enum

VatGroupRegister is optional. No default value

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

v2.SupplementProduct

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

changed

string · readOnly · required

Changed datetime.

VersionOfObjectRef · required

Fare frame ref.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:SupplementProduct:BicycleReserving

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: SupplementProduct

operatorRef

string · required

The reference to the operator.

Example: RUT:Authority:RUT

organisationRef

string · required

The reference to the organisation.

Example: ENT:Authority:ENT

status

string · enum · readOnly · required

Supplement product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

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

Supplement product version.

Example: NSB:Version:V1

accessRightParameterAssignments.

AccessRightInProduct[]

accessRightParameterAssignments.

activeComparisonOperatorVariant

string

Deprecated: this parameter is ignored.

Example: E

chargingMomentType

string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

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

A summary of a condition.

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

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

Reference to information about the fare.

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

Fare prices.

privateCode

string

Privat code.

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

Fare frame ref.