supplement-products

Server

This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard

deprecated

Retrieves a supplement products by organisation id

GET

https://api.entur.io/products

/supplement-products

This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard

Retrieves a supplement products by organisation id › query Parameters

orgId

string · style: form · explode: true

The unique id to identify a organisation

fareFrameId

string · style: form · explode: true

The unique id to idetify data owned by organisation

languageCode

string · style: form · explode: true

gpaDataSet

string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

language

string · style: form · explode: true

the unique id for the language

Retrieves a supplement products by organisation id › Headers

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves a supplement products by organisation id › Responses

Returns the info

SupplementProduct[]

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

SupplementProduct

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.

ConditionSummary

A summary of a condition.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

TextInLanguage[]

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

FarePrice[]

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

TypeOfFareProduct

A classification of FARE PRODUCTs.

GET/supplement-products

curl https://api.entur.io/products/supplement-products

Example Responses

[
  {
    "accessRightParameterAssignments": [
      {
        "canIgnoreInOffering": true,
        "changed": "changed",
        "chargingBasisType": "FREE",
        "comparisonOperatorVariant": "E",
        "compatibleWithVersionRef": "NSB:Version:V1",
        "created": "created",
        "derivedFromVersionRef": "NSB:Version:V1",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "fareProductRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "fareStructureElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:GenericParameterAssignment:AllowedOperators",
        "includes": [
          null
        ],
        "includesGroupingType": "AND",
        "limitationGroupingType": "AND",
        "limitations": [
          {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          }
        ],
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "GenericParameterAssignment",
        "parentParameterAssignmentRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "requiredElements": [
          "string"
        ],
        "requiredInContext": "OFFERING",
        "requiredType": "SERVICE_JOURNEY_REF",
        "salesPackageRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "temporalValidityParameters": [
          {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "dayType": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "derivedFromVersionRef": "derivedFromVersionRef",
            "genericParameterAssignmentRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "groupOfTimeBands": {
              "changed": "changed",
              "compatibleWithVersionRef": "compatibleWithVersionRef",
              "created": "created",
              "derivedFromVersionRef": "derivedFromVersionRef",
              "id": "id",
              "members": [
                {
                  "changed": "changed",
                  "compatibleWithVersionRef": "compatibleWithVersionRef",
                  "created": "created",
                  "dayOffset": 1,
                  "derivedFromVersionRef": "derivedFromVersionRef",
                  "description": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "endTime": "11:11:11",
                  "fareFrameRef": {
                    "nameOfClass": "nameOfClass",
                    "ref": "ref",
                    "version": "version"
                  },
                  "id": "NSB:Timeband:2HoursValidPlus1",
                  "modification": "NEW",
                  "name": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "nameOfClass": "TimeBand",
                  "startTime": "11:11:11",
                  "status": "DRAFT",
                  "timeZone": "Europe/Oslo",
                  "validityConditions": [
                    {
                      "changed": "changed",
                      "created": "created",
                      "fromDate": "fromDate",
                      "id": "NSB:ValidBetween:2018",
                      "modification": "NEW",
                      "nameOfClass": "ValidBetween",
                      "status": "DRAFT",
                      "toDate": "toDate",
                      "version": "NSB:Version:V1"
                    }
                  ],
                  "version": "NSB:Version:V1"
                }
              ],
              "modification": "NEW",
              "nameOfClass": "FareStructureElement",
              "status": "DRAFT",
              "validityConditions": [
                {
                  "changed": "changed",
                  "created": "created",
                  "fromDate": "fromDate",
                  "id": "NSB:ValidBetween:2018",
                  "modification": "NEW",
                  "nameOfClass": "ValidBetween",
                  "status": "DRAFT",
                  "toDate": "toDate",
                  "version": "NSB:Version:V1"
                }
              ],
              "version": "NSB:Version:V1"
            },
            "id": "NSB:TemporalValidityParameter:OperatorNSB",
            "modification": "NEW",
            "nameOfClass": "TemporalValidityParameter",
            "status": "DRAFT",
            "validityCondition": {
              "changed": "changed",
              "created": "created",
              "fromDate": "fromDate",
              "id": "NSB:ValidBetween:2018",
              "modification": "NEW",
              "nameOfClass": "ValidBetween",
              "status": "DRAFT",
              "toDate": "toDate",
              "version": "NSB:Version:V1"
            },
            "validityConditionRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "version": "NSB:Version:V1"
          }
        ],
        "typeOfAccessRightAssignment": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "TypeOfAccessRightAssignment",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "validableElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "validityParameterAssignmentType": "EQ",
        "validityParameterGroupingType": "AND",
        "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
        "validityParameters": [
          {
            "authorityRef": "NSB:Authority:NSB",
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "distributionChannelRef": "ENT:DistributionChannel:App",
            "facilitySetRef": "facilitySetRef",
            "fareClasses": [
              "string"
            ],
            "fareFrameRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "fareSectionRef": "fareSectionRef",
            "fareZoneRef": "KOL:FareZone:250",
            "genericParameterAssignmentRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
            "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
            "id": "NSB:ScopingValidityParameter:OperatorNSB",
            "lineRef": "lineRef",
            "lineType": "EXPRESS",
            "modification": "NEW",
            "nameOfClass": "ScopingValidityParameter",
            "operatorRef": "operatorRef",
            "placeUse": "START_AT",
            "scheduledStopPointRef": "scheduledStopPointRef",
            "status": "DRAFT",
            "tariffZoneRef": "RUT:TariffZone:2S",
            "topographicPlaceRef": "topographicPlaceRef",
            "transportSubmode": "expressBus",
            "vehicleMode": "AIR",
            "version": "NSB:Version:V1"
          }
        ],
        "version": "NSB:Version:V2"
      }
    ],
    "accessRightsInProduct": [
      {
        "accessNumber": 0,
        "accessNumberIsLimited": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:AccessRightInProduct:Ordinary",
        "isFirstInSequence": true,
        "isLastInSequence": true,
        "limitedAccessNumber": 0,
        "maximumAccess": 0,
        "minimumAccess": 0,
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Refunding",
        "orderOfElement": 0,
        "preassignedFareProductRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "validableElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "version": "NSB:Version:V1"
      }
    ],
    "activeComparisonOperatorVariant": "E",
    "changed": "changed",
    "chargingMoment": {
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:ChargingMoment:Prepaid",
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "ChargingMoment",
      "status": "DRAFT",
      "version": "NSB:Version:V1"
    },
    "chargingMomentType": "BEFORE_TRAVEL",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "conditionSummary": {
      "id": "NSB:ConditionSummary:1005TEN",
      "isExchangeable": true,
      "isRefundable": true
    },
    "created": "created",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fareProductRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "fareStructureType": "POINT_TO_POINT_FARE",
    "fareTableRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "id": "NSB:SupplementProduct:BicycleReserving",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "SupplementProduct",
    "operatorRef": "RUT:Authority:RUT",
    "organisation": "organisation",
    "organisationId": "organisationId",
    "prices": [
      {
        "amount": "164.0",
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "currency": "NOK",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "discountPercentageUsed": 5,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:FarePrice:1005TEN",
        "isAllowed": true,
        "limitingRule": {
          "canBeCumulative": true,
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "discountAsPercentage": 0,
          "discountAsValue": 0,
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "id",
          "maximumPrice": "164.0",
          "maximumPriceAsPercentage": 0,
          "minimumLimitPrice": "164.0",
          "minimumPrice": "164.0",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "LimitingRule",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "FarePrice",
        "ranking": 1,
        "rounding": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "NSB:Rounding:Ordinary",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "Rounding",
          "roundingMethod": "NONE",
          "roundingModulus": 0,
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "roundingRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
        "version": "NSB:Version:V1"
      }
    ],
    "pricingRuleRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "privateCode": "privateCode",
    "status": "DRAFT",
    "supplementProductType": "SEAT_RESERVATION",
    "typeOfFareProduct": {
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:TypeOfFareProduct:Ordinary",
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "TypeOfFareProduct",
      "status": "DRAFT",
      "version": "NSB:Version:V1"
    },
    "validityConditions": [
      {
        "changed": "changed",
        "created": "created",
        "fromDate": "fromDate",
        "id": "NSB:ValidBetween:2018",
        "modification": "NEW",
        "nameOfClass": "ValidBetween",
        "status": "DRAFT",
        "toDate": "toDate",
        "version": "NSB:Version:V1"
      }
    ],
    "vatGroup": "EXCEPTION_FROM_VAT",
    "version": "NSB:Version:V1"
  }
]

json

application/json

deprecated

Create a SupplementProduct

POST

https://api.entur.io/products

/supplement-products

This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard

Create a SupplementProduct › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Create a SupplementProduct › Request Body

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

VersionOfObjectRef[]

AccessRightParameterAssignments.

AccessRightInProductInsert[]

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.

TextInLanguage[]

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

VersionOfObjectRef[]

FareTableRef.

FarePriceInsert[]

Fare prices.

privateCode

string

PrivateCode.

supplementProductType

string · enum

SupplementProductType.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

Example: SEAT_RESERVATION

VersionOfObjectRef

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

Create a SupplementProduct › Responses

Entity created successfully

No data returned

POST/supplement-products

curl https://api.entur.io/products/supplement-products \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accessRightParameterAssignmentRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "ZONE_TO_ZONE_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:LargeAnimal",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "operatorRef": "RUT:Authority:RUT",
  "organisation": "organisation",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "ranking": 1,
      "rounding": {
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "version"
    }
  ],
  "privateCode": "privateCode",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "accessRightParameterAssignmentRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "ZONE_TO_ZONE_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:LargeAnimal",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "operatorRef": "RUT:Authority:RUT",
  "organisation": "organisation",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "ranking": 1,
      "rounding": {
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "version"
    }
  ],
  "privateCode": "privateCode",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

deprecated

Retrieves the latest version of supplement products by id

GET

https://api.entur.io/products

/supplement-products/{id}

This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard

Retrieves the latest version of supplement products by id › path Parameters

id

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

The unique id to identify a product

Retrieves the latest version of supplement products by id › query Parameters

version

string · style: form · explode: true

The id of the version of the fare structure element

languageCode

string · style: form · explode: true

The language code from ISO-639-3

gpaDataSet

string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

Retrieves the latest version of supplement products by id › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves the latest version of supplement products by id › Responses

Returns the resource

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

SupplementProduct

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.

ConditionSummary

A summary of a condition.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

TextInLanguage[]

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

FarePrice[]

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

TypeOfFareProduct

A classification of FARE PRODUCTs.

GET/supplement-products/{id}

curl https://api.entur.io/products/supplement-products/:id

Example Responses

{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMoment": {
    "changed": "changed",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "created",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "id": "NSB:ChargingMoment:Prepaid",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "ChargingMoment",
    "status": "DRAFT",
    "version": "NSB:Version:V1"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareProductRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisation": "organisation",
  "organisationId": "organisationId",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "pricingRuleRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProduct": {
    "changed": "changed",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "created",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "id": "NSB:TypeOfFareProduct:Ordinary",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "TypeOfFareProduct",
    "status": "DRAFT",
    "version": "NSB:Version:V1"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroup": "EXCEPTION_FROM_VAT",
  "version": "NSB:Version:V1"
}

json

application/json

deprecated

Retrives refunding rules by fare product id and version

GET

https://api.entur.io/products

/supplement-products/{id}/refunding

This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard

Retrives refunding rules by fare product id and version › path Parameters

id

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

The unique id to identify a fareProduct

Retrives refunding rules by fare product id and version › query Parameters

version

string · style: form · explode: true

languageCode

string · style: form · explode: true

the unique id for the language

productVersionId

string · style: form · explode: true

The version of the fareProduct

Retrives refunding rules by fare product id and version › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrives refunding rules by fare product id and version › Responses

Returns the info

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.

TextInLanguage[]

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.

VersionOfObjectRef

Fare frame ref.

TextInLanguage[]

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

onlyAtCertainDistributionPoints

boolean

Whether distribution is restricted to certain points.

FarePrice[]

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.

GET/supplement-products/{id}/refunding

curl https://api.entur.io/products/supplement-products/:id/refunding

Example Responses

{
  "allowed": "FULL",
  "canChangeClass": true,
  "changed": "changed",
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "created": "created",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "exchangeableFromAnyTime": true,
  "exchangeableFromDuration": "PT24H",
  "exchangeableUntilAnyTime": true,
  "exchangeableUntilDuration": "exchangeableUntilDuration",
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "hasFee": true,
  "id": "NSB:Refunding:FullRefundUntilLimit",
  "limitingRule": "limitingRule",
  "limitingRuleRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "Refunding",
  "onlyAtCertainDistributionPoints": true,
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "refundBasis": "PER_OFFER",
  "refundType": "UNUSED",
  "resellWhen": "NEVER",
  "status": "DRAFT",
  "unusedTicketsOnly": true,
  "version": "NSB:Version:V1"
}

json

application/json

deprecated

Retrieves the latest version of supplement product by id and version

GET

https://api.entur.io/products

/supplement-products/{id}/{version}

This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard

Retrieves the latest version of supplement product by id and version › path Parameters

id

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

The unique id to identify a product

version

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

The id of the version of the fare structure element

Retrieves the latest version of supplement product by id and version › query Parameters

gpaDataSet

string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

Retrieves the latest version of supplement product by id and version › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · style: simple

The language code from ISO-639-3

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves the latest version of supplement product by id and version › Responses

Returns the resource

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

SupplementProduct

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.

ConditionSummary

A summary of a condition.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

TextInLanguage[]

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

FarePrice[]

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

TypeOfFareProduct

A classification of FARE PRODUCTs.

GET/supplement-products/{id}/{version}

curl https://api.entur.io/products/supplement-products/:id/:version

Example Responses

{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMoment": {
    "changed": "changed",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "created",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "id": "NSB:ChargingMoment:Prepaid",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "ChargingMoment",
    "status": "DRAFT",
    "version": "NSB:Version:V1"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareProductRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisation": "organisation",
  "organisationId": "organisationId",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "pricingRuleRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProduct": {
    "changed": "changed",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "created",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "id": "NSB:TypeOfFareProduct:Ordinary",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "TypeOfFareProduct",
    "status": "DRAFT",
    "version": "NSB:Version:V1"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroup": "EXCEPTION_FROM_VAT",
  "version": "NSB:Version:V1"
}

json

application/json

deprecated

Update a supplement product parameter.

PUT

https://api.entur.io/products

/supplement-products/{id}/{version}

This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard

Update a supplement product parameter. › path Parameters

id

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

The unique id to identify a product

version

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

The id of the version of the fare structure element

Update a supplement product parameter. › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Update a supplement product parameter. › Request Body

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

VersionOfObjectRef[]

AccessRightParameterAssignments.

AccessRightInProductInsert[]

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.

TextInLanguage[]

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

VersionOfObjectRef[]

FareTableRef.

FarePriceInsert[]

Fare prices.

privateCode

string

PrivateCode.

supplementProductType

string · enum

SupplementProductType.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

Example: SEAT_RESERVATION

VersionOfObjectRef

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

Update a supplement product parameter. › Responses

Entity updated successfully

No data returned

PUT/supplement-products/{id}/{version}

curl https://api.entur.io/products/supplement-products/:id/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "accessRightParameterAssignmentRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "ZONE_TO_ZONE_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:LargeAnimal",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "operatorRef": "RUT:Authority:RUT",
  "organisation": "organisation",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "ranking": 1,
      "rounding": {
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "version"
    }
  ],
  "privateCode": "privateCode",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "accessRightParameterAssignmentRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "ZONE_TO_ZONE_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:LargeAnimal",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "operatorRef": "RUT:Authority:RUT",
  "organisation": "organisation",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "ranking": 1,
      "rounding": {
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "version"
    }
  ],
  "privateCode": "privateCode",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

deprecated

Retrieves the latest version of supplement product by id

GET

https://api.entur.io/products

/v1/supplement-products/{id}

This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard

Retrieves the latest version of supplement product by id › path Parameters

id

string · required · style: simple

The unique id to identify a product

Retrieves the latest version of supplement product by id › query Parameters

startDate

string · style: form · explode: true

endDate

string · style: form · explode: true

status

string · style: form · explode: true

The version status of the product

gpaDataSet

string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

fromDate

string · style: form · explode: true

The from date of the products version

toDate

string · style: form · explode: true

The to date of the products version

Retrieves the latest version of supplement product by id › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · style: simple

The language code from ISO-639-3

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves the latest version of supplement product by id › Responses

Returns the resource

SupplementProduct[]

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

SupplementProduct

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.

ConditionSummary

A summary of a condition.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

TextInLanguage[]

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

FarePrice[]

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

TypeOfFareProduct

A classification of FARE PRODUCTs.

GET/v1/supplement-products/{id}

curl https://api.entur.io/products/v1/supplement-products/:id

Example Responses

[
  {
    "accessRightParameterAssignments": [
      {
        "canIgnoreInOffering": true,
        "changed": "changed",
        "chargingBasisType": "FREE",
        "comparisonOperatorVariant": "E",
        "compatibleWithVersionRef": "NSB:Version:V1",
        "created": "created",
        "derivedFromVersionRef": "NSB:Version:V1",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "fareProductRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "fareStructureElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:GenericParameterAssignment:AllowedOperators",
        "includes": [
          null
        ],
        "includesGroupingType": "AND",
        "limitationGroupingType": "AND",
        "limitations": [
          {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          }
        ],
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "GenericParameterAssignment",
        "parentParameterAssignmentRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "requiredElements": [
          "string"
        ],
        "requiredInContext": "OFFERING",
        "requiredType": "SERVICE_JOURNEY_REF",
        "salesPackageRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "temporalValidityParameters": [
          {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "dayType": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "derivedFromVersionRef": "derivedFromVersionRef",
            "genericParameterAssignmentRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "groupOfTimeBands": {
              "changed": "changed",
              "compatibleWithVersionRef": "compatibleWithVersionRef",
              "created": "created",
              "derivedFromVersionRef": "derivedFromVersionRef",
              "id": "id",
              "members": [
                {
                  "changed": "changed",
                  "compatibleWithVersionRef": "compatibleWithVersionRef",
                  "created": "created",
                  "dayOffset": 1,
                  "derivedFromVersionRef": "derivedFromVersionRef",
                  "description": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "endTime": "11:11:11",
                  "fareFrameRef": {
                    "nameOfClass": "nameOfClass",
                    "ref": "ref",
                    "version": "version"
                  },
                  "id": "NSB:Timeband:2HoursValidPlus1",
                  "modification": "NEW",
                  "name": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "nameOfClass": "TimeBand",
                  "startTime": "11:11:11",
                  "status": "DRAFT",
                  "timeZone": "Europe/Oslo",
                  "validityConditions": [
                    {
                      "changed": "changed",
                      "created": "created",
                      "fromDate": "fromDate",
                      "id": "NSB:ValidBetween:2018",
                      "modification": "NEW",
                      "nameOfClass": "ValidBetween",
                      "status": "DRAFT",
                      "toDate": "toDate",
                      "version": "NSB:Version:V1"
                    }
                  ],
                  "version": "NSB:Version:V1"
                }
              ],
              "modification": "NEW",
              "nameOfClass": "FareStructureElement",
              "status": "DRAFT",
              "validityConditions": [
                {
                  "changed": "changed",
                  "created": "created",
                  "fromDate": "fromDate",
                  "id": "NSB:ValidBetween:2018",
                  "modification": "NEW",
                  "nameOfClass": "ValidBetween",
                  "status": "DRAFT",
                  "toDate": "toDate",
                  "version": "NSB:Version:V1"
                }
              ],
              "version": "NSB:Version:V1"
            },
            "id": "NSB:TemporalValidityParameter:OperatorNSB",
            "modification": "NEW",
            "nameOfClass": "TemporalValidityParameter",
            "status": "DRAFT",
            "validityCondition": {
              "changed": "changed",
              "created": "created",
              "fromDate": "fromDate",
              "id": "NSB:ValidBetween:2018",
              "modification": "NEW",
              "nameOfClass": "ValidBetween",
              "status": "DRAFT",
              "toDate": "toDate",
              "version": "NSB:Version:V1"
            },
            "validityConditionRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "version": "NSB:Version:V1"
          }
        ],
        "typeOfAccessRightAssignment": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "TypeOfAccessRightAssignment",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "validableElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "validityParameterAssignmentType": "EQ",
        "validityParameterGroupingType": "AND",
        "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
        "validityParameters": [
          {
            "authorityRef": "NSB:Authority:NSB",
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "distributionChannelRef": "ENT:DistributionChannel:App",
            "facilitySetRef": "facilitySetRef",
            "fareClasses": [
              "string"
            ],
            "fareFrameRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "fareSectionRef": "fareSectionRef",
            "fareZoneRef": "KOL:FareZone:250",
            "genericParameterAssignmentRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
            "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
            "id": "NSB:ScopingValidityParameter:OperatorNSB",
            "lineRef": "lineRef",
            "lineType": "EXPRESS",
            "modification": "NEW",
            "nameOfClass": "ScopingValidityParameter",
            "operatorRef": "operatorRef",
            "placeUse": "START_AT",
            "scheduledStopPointRef": "scheduledStopPointRef",
            "status": "DRAFT",
            "tariffZoneRef": "RUT:TariffZone:2S",
            "topographicPlaceRef": "topographicPlaceRef",
            "transportSubmode": "expressBus",
            "vehicleMode": "AIR",
            "version": "NSB:Version:V1"
          }
        ],
        "version": "NSB:Version:V2"
      }
    ],
    "accessRightsInProduct": [
      {
        "accessNumber": 0,
        "accessNumberIsLimited": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:AccessRightInProduct:Ordinary",
        "isFirstInSequence": true,
        "isLastInSequence": true,
        "limitedAccessNumber": 0,
        "maximumAccess": 0,
        "minimumAccess": 0,
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Refunding",
        "orderOfElement": 0,
        "preassignedFareProductRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "validableElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "version": "NSB:Version:V1"
      }
    ],
    "activeComparisonOperatorVariant": "E",
    "changed": "changed",
    "chargingMoment": {
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:ChargingMoment:Prepaid",
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "ChargingMoment",
      "status": "DRAFT",
      "version": "NSB:Version:V1"
    },
    "chargingMomentType": "BEFORE_TRAVEL",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "conditionSummary": {
      "id": "NSB:ConditionSummary:1005TEN",
      "isExchangeable": true,
      "isRefundable": true
    },
    "created": "created",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fareProductRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "fareStructureType": "POINT_TO_POINT_FARE",
    "fareTableRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "id": "NSB:SupplementProduct:BicycleReserving",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "SupplementProduct",
    "operatorRef": "RUT:Authority:RUT",
    "organisation": "organisation",
    "organisationId": "organisationId",
    "prices": [
      {
        "amount": "164.0",
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "currency": "NOK",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "discountPercentageUsed": 5,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:FarePrice:1005TEN",
        "isAllowed": true,
        "limitingRule": {
          "canBeCumulative": true,
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "discountAsPercentage": 0,
          "discountAsValue": 0,
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "id",
          "maximumPrice": "164.0",
          "maximumPriceAsPercentage": 0,
          "minimumLimitPrice": "164.0",
          "minimumPrice": "164.0",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "LimitingRule",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "FarePrice",
        "ranking": 1,
        "rounding": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "NSB:Rounding:Ordinary",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "Rounding",
          "roundingMethod": "NONE",
          "roundingModulus": 0,
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "roundingRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
        "version": "NSB:Version:V1"
      }
    ],
    "pricingRuleRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "privateCode": "privateCode",
    "status": "DRAFT",
    "supplementProductType": "SEAT_RESERVATION",
    "typeOfFareProduct": {
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:TypeOfFareProduct:Ordinary",
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "TypeOfFareProduct",
      "status": "DRAFT",
      "version": "NSB:Version:V1"
    },
    "validityConditions": [
      {
        "changed": "changed",
        "created": "created",
        "fromDate": "fromDate",
        "id": "NSB:ValidBetween:2018",
        "modification": "NEW",
        "nameOfClass": "ValidBetween",
        "status": "DRAFT",
        "toDate": "toDate",
        "version": "NSB:Version:V1"
      }
    ],
    "vatGroup": "EXCEPTION_FROM_VAT",
    "version": "NSB:Version:V1"
  }
]

json

application/json

Retrieves all supplement products

GET

https://api.entur.io/products

/v2/supplement-products

Retrieves all supplement products › query Parameters

orgId

string · style: form · explode: true

The unique id to identify an organisation

fareFrameId

string · style: form · explode: true

The unique id to identify a dataset to an organisation

minimizeDataLoad

boolean · style: form · explode: true

Possibility of opting out of including child elements

gpaDataSet

string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

statusFilter

string[] · style: form · explode: true

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.

validOnDate

string · style: form · explode: true

Return the SupplementProducts valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SupplementProducts are returned. And in the staging environment, PROPOSED SupplementProducts are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

Retrieves all supplement products › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves all supplement products › Responses

Returns the info

v2.SupplementProduct[]

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

v2.SupplementProduct

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

GenericParameterAssignment[]

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

ConditionSummary

A summary of a condition.

TextInLanguage[]

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

VersionOfObjectRef[]

Reference to information about the fare.

TextInLanguage[]

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

FarePrice[]

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

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

validityConditions.

vatGroupRegister

string · enum

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

GET/v2/supplement-products

curl https://api.entur.io/products/v2/supplement-products

Example Responses

[
  {
    "accessRightParameterAssignments": [
      {
        "canIgnoreInOffering": true,
        "changed": "changed",
        "chargingBasisType": "FREE",
        "comparisonOperatorVariant": "E",
        "compatibleWithVersionRef": "NSB:Version:V1",
        "created": "created",
        "derivedFromVersionRef": "NSB:Version:V1",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "fareProductRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "fareStructureElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:GenericParameterAssignment:AllowedOperators",
        "includes": [
          null
        ],
        "includesGroupingType": "AND",
        "limitationGroupingType": "AND",
        "limitations": [
          {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          }
        ],
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "GenericParameterAssignment",
        "parentParameterAssignmentRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "requiredElements": [
          "string"
        ],
        "requiredInContext": "OFFERING",
        "requiredType": "SERVICE_JOURNEY_REF",
        "salesPackageRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "temporalValidityParameters": [
          {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "dayType": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "derivedFromVersionRef": "derivedFromVersionRef",
            "genericParameterAssignmentRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "groupOfTimeBands": {
              "changed": "changed",
              "compatibleWithVersionRef": "compatibleWithVersionRef",
              "created": "created",
              "derivedFromVersionRef": "derivedFromVersionRef",
              "id": "id",
              "members": [
                {
                  "changed": "changed",
                  "compatibleWithVersionRef": "compatibleWithVersionRef",
                  "created": "created",
                  "dayOffset": 1,
                  "derivedFromVersionRef": "derivedFromVersionRef",
                  "description": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "endTime": "11:11:11",
                  "fareFrameRef": {
                    "nameOfClass": "nameOfClass",
                    "ref": "ref",
                    "version": "version"
                  },
                  "id": "NSB:Timeband:2HoursValidPlus1",
                  "modification": "NEW",
                  "name": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "nameOfClass": "TimeBand",
                  "startTime": "11:11:11",
                  "status": "DRAFT",
                  "timeZone": "Europe/Oslo",
                  "validityConditions": [
                    {
                      "changed": "changed",
                      "created": "created",
                      "fromDate": "fromDate",
                      "id": "NSB:ValidBetween:2018",
                      "modification": "NEW",
                      "nameOfClass": "ValidBetween",
                      "status": "DRAFT",
                      "toDate": "toDate",
                      "version": "NSB:Version:V1"
                    }
                  ],
                  "version": "NSB:Version:V1"
                }
              ],
              "modification": "NEW",
              "nameOfClass": "FareStructureElement",
              "status": "DRAFT",
              "validityConditions": [
                {
                  "changed": "changed",
                  "created": "created",
                  "fromDate": "fromDate",
                  "id": "NSB:ValidBetween:2018",
                  "modification": "NEW",
                  "nameOfClass": "ValidBetween",
                  "status": "DRAFT",
                  "toDate": "toDate",
                  "version": "NSB:Version:V1"
                }
              ],
              "version": "NSB:Version:V1"
            },
            "id": "NSB:TemporalValidityParameter:OperatorNSB",
            "modification": "NEW",
            "nameOfClass": "TemporalValidityParameter",
            "status": "DRAFT",
            "validityCondition": {
              "changed": "changed",
              "created": "created",
              "fromDate": "fromDate",
              "id": "NSB:ValidBetween:2018",
              "modification": "NEW",
              "nameOfClass": "ValidBetween",
              "status": "DRAFT",
              "toDate": "toDate",
              "version": "NSB:Version:V1"
            },
            "validityConditionRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "version": "NSB:Version:V1"
          }
        ],
        "typeOfAccessRightAssignment": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "TypeOfAccessRightAssignment",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "validableElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "validityParameterAssignmentType": "EQ",
        "validityParameterGroupingType": "AND",
        "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
        "validityParameters": [
          {
            "authorityRef": "NSB:Authority:NSB",
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "distributionChannelRef": "ENT:DistributionChannel:App",
            "facilitySetRef": "facilitySetRef",
            "fareClasses": [
              "string"
            ],
            "fareFrameRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "fareSectionRef": "fareSectionRef",
            "fareZoneRef": "KOL:FareZone:250",
            "genericParameterAssignmentRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
            "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
            "id": "NSB:ScopingValidityParameter:OperatorNSB",
            "lineRef": "lineRef",
            "lineType": "EXPRESS",
            "modification": "NEW",
            "nameOfClass": "ScopingValidityParameter",
            "operatorRef": "operatorRef",
            "placeUse": "START_AT",
            "scheduledStopPointRef": "scheduledStopPointRef",
            "status": "DRAFT",
            "tariffZoneRef": "RUT:TariffZone:2S",
            "topographicPlaceRef": "topographicPlaceRef",
            "transportSubmode": "expressBus",
            "vehicleMode": "AIR",
            "version": "NSB:Version:V1"
          }
        ],
        "version": "NSB:Version:V2"
      }
    ],
    "accessRightsInProduct": [
      {
        "accessNumber": 0,
        "accessNumberIsLimited": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:AccessRightInProduct:Ordinary",
        "isFirstInSequence": true,
        "isLastInSequence": true,
        "limitedAccessNumber": 0,
        "maximumAccess": 0,
        "minimumAccess": 0,
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Refunding",
        "orderOfElement": 0,
        "preassignedFareProductRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "validableElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "version": "NSB:Version:V1"
      }
    ],
    "activeComparisonOperatorVariant": "E",
    "changed": "changed",
    "chargingMomentRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "chargingMomentType": "BEFORE_TRAVEL",
    "conditionSummary": {
      "id": "NSB:ConditionSummary:1005TEN",
      "isExchangeable": true,
      "isRefundable": true
    },
    "created": "created",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fareStructureType": "POINT_TO_POINT_FARE",
    "fareTableRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "id": "NSB:SupplementProduct:BicycleReserving",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "SupplementProduct",
    "operatorRef": "RUT:Authority:RUT",
    "organisationRef": "ENT:Authority:ENT",
    "prices": [
      {
        "amount": "164.0",
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "currency": "NOK",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "discountPercentageUsed": 5,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:FarePrice:1005TEN",
        "isAllowed": true,
        "limitingRule": {
          "canBeCumulative": true,
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "discountAsPercentage": 0,
          "discountAsValue": 0,
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "id",
          "maximumPrice": "164.0",
          "maximumPriceAsPercentage": 0,
          "minimumLimitPrice": "164.0",
          "minimumPrice": "164.0",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "LimitingRule",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "FarePrice",
        "ranking": 1,
        "rounding": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "NSB:Rounding:Ordinary",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "Rounding",
          "roundingMethod": "NONE",
          "roundingModulus": 0,
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "roundingRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
        "version": "NSB:Version:V1"
      }
    ],
    "privateCode": "privateCode",
    "status": "DRAFT",
    "supplementProductType": "SEAT_RESERVATION",
    "typeOfFareProductRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "validityConditions": [
      {
        "changed": "changed",
        "created": "created",
        "fromDate": "fromDate",
        "id": "NSB:ValidBetween:2018",
        "modification": "NEW",
        "nameOfClass": "ValidBetween",
        "status": "DRAFT",
        "toDate": "toDate",
        "version": "NSB:Version:V1"
      }
    ],
    "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
    "version": "NSB:Version:V1"
  }
]

json

application/json

Creates a new supplement product

POST

https://api.entur.io/products

/v2/supplement-products

Creates a new supplement product › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Creates a new supplement product › Request Body

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

v2.SupplementProduct

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

GenericParameterAssignment[]

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

ConditionSummary

A summary of a condition.

TextInLanguage[]

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

VersionOfObjectRef[]

Reference to information about the fare.

TextInLanguage[]

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

FarePrice[]

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

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

validityConditions.

vatGroupRegister

string · enum

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

Creates a new supplement product › Responses

Returns the created supplement product

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

v2.SupplementProduct

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

GenericParameterAssignment[]

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

ConditionSummary

A summary of a condition.

TextInLanguage[]

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

VersionOfObjectRef[]

Reference to information about the fare.

TextInLanguage[]

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

FarePrice[]

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

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

validityConditions.

vatGroupRegister

string · enum

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

POST/v2/supplement-products

curl https://api.entur.io/products/v2/supplement-products \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisationRef": "ENT:Authority:ENT",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisationRef": "ENT:Authority:ENT",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}

json

Example Responses

{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisationRef": "ENT:Authority:ENT",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}

json

application/json

Retrieves a supplement product by id. When 'validOnDate' is omitted, returns the version valid today.

GET

https://api.entur.io/products

/v2/supplement-products/{id}

Optional validOnDate query parameter (defaults to now). In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.

Retrieves a supplement product by id. When 'validOnDate' is omitted, returns the version valid today. › path Parameters

id

string · required · style: simple

The id to identify a supplement product

Retrieves a supplement product by id. When 'validOnDate' is omitted, returns the version valid today. › query Parameters

validOnDate

string · date-time · style: form · explode: true

Return the version valid on the given date (ISO-8601). Defaults to now.

gpaDataSet

string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

Retrieves a supplement product by id. When 'validOnDate' is omitted, returns the version valid today. › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves a supplement product by id. When 'validOnDate' is omitted, returns the version valid today. › Responses

Returns the supplement product

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

v2.SupplementProduct

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

GenericParameterAssignment[]

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

ConditionSummary

A summary of a condition.

TextInLanguage[]

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

VersionOfObjectRef[]

Reference to information about the fare.

TextInLanguage[]

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

FarePrice[]

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

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

validityConditions.

vatGroupRegister

string · enum

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

GET/v2/supplement-products/{id}

curl https://api.entur.io/products/v2/supplement-products/:id

Example Responses

{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisationRef": "ENT:Authority:ENT",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}

json

application/json

Retrieves all versions of a supplement product

GET

https://api.entur.io/products

/v2/supplement-products/{id}/versions

Retrieves all versions of a supplement product › path Parameters

id

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

The id to identify a supplement product

Retrieves all versions of a supplement product › query Parameters

active

boolean · style: form · explode: true

If value is set to true only active versions will be returned, otherwise all versions will be returned

Retrieves all versions of a supplement product › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves all versions of a supplement product › Responses

Returns the info

v2.SupplementProduct[]

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

v2.SupplementProduct

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

GenericParameterAssignment[]

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

ConditionSummary

A summary of a condition.

TextInLanguage[]

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

VersionOfObjectRef[]

Reference to information about the fare.

TextInLanguage[]

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

FarePrice[]

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

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

validityConditions.

vatGroupRegister

string · enum

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

GET/v2/supplement-products/{id}/versions

curl https://api.entur.io/products/v2/supplement-products/:id/versions

Example Responses

[
  {
    "accessRightParameterAssignments": [
      {
        "canIgnoreInOffering": true,
        "changed": "changed",
        "chargingBasisType": "FREE",
        "comparisonOperatorVariant": "E",
        "compatibleWithVersionRef": "NSB:Version:V1",
        "created": "created",
        "derivedFromVersionRef": "NSB:Version:V1",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "fareProductRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "fareStructureElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:GenericParameterAssignment:AllowedOperators",
        "includes": [
          null
        ],
        "includesGroupingType": "AND",
        "limitationGroupingType": "AND",
        "limitations": [
          {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          }
        ],
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "GenericParameterAssignment",
        "parentParameterAssignmentRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "requiredElements": [
          "string"
        ],
        "requiredInContext": "OFFERING",
        "requiredType": "SERVICE_JOURNEY_REF",
        "salesPackageRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "temporalValidityParameters": [
          {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "dayType": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "derivedFromVersionRef": "derivedFromVersionRef",
            "genericParameterAssignmentRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "groupOfTimeBands": {
              "changed": "changed",
              "compatibleWithVersionRef": "compatibleWithVersionRef",
              "created": "created",
              "derivedFromVersionRef": "derivedFromVersionRef",
              "id": "id",
              "members": [
                {
                  "changed": "changed",
                  "compatibleWithVersionRef": "compatibleWithVersionRef",
                  "created": "created",
                  "dayOffset": 1,
                  "derivedFromVersionRef": "derivedFromVersionRef",
                  "description": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "endTime": "11:11:11",
                  "fareFrameRef": {
                    "nameOfClass": "nameOfClass",
                    "ref": "ref",
                    "version": "version"
                  },
                  "id": "NSB:Timeband:2HoursValidPlus1",
                  "modification": "NEW",
                  "name": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "nameOfClass": "TimeBand",
                  "startTime": "11:11:11",
                  "status": "DRAFT",
                  "timeZone": "Europe/Oslo",
                  "validityConditions": [
                    {
                      "changed": "changed",
                      "created": "created",
                      "fromDate": "fromDate",
                      "id": "NSB:ValidBetween:2018",
                      "modification": "NEW",
                      "nameOfClass": "ValidBetween",
                      "status": "DRAFT",
                      "toDate": "toDate",
                      "version": "NSB:Version:V1"
                    }
                  ],
                  "version": "NSB:Version:V1"
                }
              ],
              "modification": "NEW",
              "nameOfClass": "FareStructureElement",
              "status": "DRAFT",
              "validityConditions": [
                {
                  "changed": "changed",
                  "created": "created",
                  "fromDate": "fromDate",
                  "id": "NSB:ValidBetween:2018",
                  "modification": "NEW",
                  "nameOfClass": "ValidBetween",
                  "status": "DRAFT",
                  "toDate": "toDate",
                  "version": "NSB:Version:V1"
                }
              ],
              "version": "NSB:Version:V1"
            },
            "id": "NSB:TemporalValidityParameter:OperatorNSB",
            "modification": "NEW",
            "nameOfClass": "TemporalValidityParameter",
            "status": "DRAFT",
            "validityCondition": {
              "changed": "changed",
              "created": "created",
              "fromDate": "fromDate",
              "id": "NSB:ValidBetween:2018",
              "modification": "NEW",
              "nameOfClass": "ValidBetween",
              "status": "DRAFT",
              "toDate": "toDate",
              "version": "NSB:Version:V1"
            },
            "validityConditionRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "version": "NSB:Version:V1"
          }
        ],
        "typeOfAccessRightAssignment": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "TypeOfAccessRightAssignment",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "validableElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "validityParameterAssignmentType": "EQ",
        "validityParameterGroupingType": "AND",
        "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
        "validityParameters": [
          {
            "authorityRef": "NSB:Authority:NSB",
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "distributionChannelRef": "ENT:DistributionChannel:App",
            "facilitySetRef": "facilitySetRef",
            "fareClasses": [
              "string"
            ],
            "fareFrameRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "fareSectionRef": "fareSectionRef",
            "fareZoneRef": "KOL:FareZone:250",
            "genericParameterAssignmentRef": {
              "nameOfClass": "nameOfClass",
              "ref": "ref",
              "version": "version"
            },
            "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
            "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
            "id": "NSB:ScopingValidityParameter:OperatorNSB",
            "lineRef": "lineRef",
            "lineType": "EXPRESS",
            "modification": "NEW",
            "nameOfClass": "ScopingValidityParameter",
            "operatorRef": "operatorRef",
            "placeUse": "START_AT",
            "scheduledStopPointRef": "scheduledStopPointRef",
            "status": "DRAFT",
            "tariffZoneRef": "RUT:TariffZone:2S",
            "topographicPlaceRef": "topographicPlaceRef",
            "transportSubmode": "expressBus",
            "vehicleMode": "AIR",
            "version": "NSB:Version:V1"
          }
        ],
        "version": "NSB:Version:V2"
      }
    ],
    "accessRightsInProduct": [
      {
        "accessNumber": 0,
        "accessNumberIsLimited": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:AccessRightInProduct:Ordinary",
        "isFirstInSequence": true,
        "isLastInSequence": true,
        "limitedAccessNumber": 0,
        "maximumAccess": 0,
        "minimumAccess": 0,
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Refunding",
        "orderOfElement": 0,
        "preassignedFareProductRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "validableElementRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "version": "NSB:Version:V1"
      }
    ],
    "activeComparisonOperatorVariant": "E",
    "changed": "changed",
    "chargingMomentRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "chargingMomentType": "BEFORE_TRAVEL",
    "conditionSummary": {
      "id": "NSB:ConditionSummary:1005TEN",
      "isExchangeable": true,
      "isRefundable": true
    },
    "created": "created",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fareStructureType": "POINT_TO_POINT_FARE",
    "fareTableRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "id": "NSB:SupplementProduct:BicycleReserving",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "SupplementProduct",
    "operatorRef": "RUT:Authority:RUT",
    "organisationRef": "ENT:Authority:ENT",
    "prices": [
      {
        "amount": "164.0",
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "currency": "NOK",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "discountPercentageUsed": 5,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:FarePrice:1005TEN",
        "isAllowed": true,
        "limitingRule": {
          "canBeCumulative": true,
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "discountAsPercentage": 0,
          "discountAsValue": 0,
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "id",
          "maximumPrice": "164.0",
          "maximumPriceAsPercentage": 0,
          "minimumLimitPrice": "164.0",
          "minimumPrice": "164.0",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "LimitingRule",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "FarePrice",
        "ranking": 1,
        "rounding": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "NSB:Rounding:Ordinary",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "Rounding",
          "roundingMethod": "NONE",
          "roundingModulus": 0,
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "roundingRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
        "version": "NSB:Version:V1"
      }
    ],
    "privateCode": "privateCode",
    "status": "DRAFT",
    "supplementProductType": "SEAT_RESERVATION",
    "typeOfFareProductRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "validityConditions": [
      {
        "changed": "changed",
        "created": "created",
        "fromDate": "fromDate",
        "id": "NSB:ValidBetween:2018",
        "modification": "NEW",
        "nameOfClass": "ValidBetween",
        "status": "DRAFT",
        "toDate": "toDate",
        "version": "NSB:Version:V1"
      }
    ],
    "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
    "version": "NSB:Version:V1"
  }
]

json

application/json

Retrieves a supplement product by id and version

GET

https://api.entur.io/products

/v2/supplement-products/{id}/{version}

Retrieves a supplement product by id and version › path Parameters

id

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

The id to identify a supplement product

version

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

The id for the version of the supplement product

Retrieves a supplement product by id and version › query Parameters

gpaDataSet

string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

Retrieves a supplement product by id and version › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves a supplement product by id and version › Responses

Returns the supplement product

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

v2.SupplementProduct

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

GenericParameterAssignment[]

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

ConditionSummary

A summary of a condition.

TextInLanguage[]

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

VersionOfObjectRef[]

Reference to information about the fare.

TextInLanguage[]

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

FarePrice[]

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

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

validityConditions.

vatGroupRegister

string · enum

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

GET/v2/supplement-products/{id}/{version}

curl https://api.entur.io/products/v2/supplement-products/:id/:version

Example Responses

{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisationRef": "ENT:Authority:ENT",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}

json

application/json

Updates an existing supplement product

PUT

https://api.entur.io/products

/v2/supplement-products/{id}/{version}

Updates an existing supplement product › path Parameters

id

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

The id to identify a supplement product

version

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

The id for the version of the supplement product

Updates an existing supplement product › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Updates an existing supplement product › Request Body

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

v2.SupplementProduct

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

GenericParameterAssignment[]

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

ConditionSummary

A summary of a condition.

TextInLanguage[]

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

VersionOfObjectRef[]

Reference to information about the fare.

TextInLanguage[]

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

FarePrice[]

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

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

validityConditions.

vatGroupRegister

string · enum

The VAT group for the SupplementProduct.

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

Updates an existing supplement product › Responses

Entity updated successfully

No data returned

PUT/v2/supplement-products/{id}/{version}

curl https://api.entur.io/products/v2/supplement-products/:id/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisationRef": "ENT:Authority:ENT",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "accessRightParameterAssignments": [
    {
      "canIgnoreInOffering": true,
      "changed": "changed",
      "chargingBasisType": "FREE",
      "comparisonOperatorVariant": "E",
      "compatibleWithVersionRef": "NSB:Version:V1",
      "created": "created",
      "derivedFromVersionRef": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "fareStructureElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:GenericParameterAssignment:AllowedOperators",
      "includes": [
        null
      ],
      "includesGroupingType": "AND",
      "limitationGroupingType": "AND",
      "limitations": [
        {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        }
      ],
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "GenericParameterAssignment",
      "parentParameterAssignmentRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "requiredElements": [
        "string"
      ],
      "requiredInContext": "OFFERING",
      "requiredType": "SERVICE_JOURNEY_REF",
      "salesPackageRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "temporalValidityParameters": [
        {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "dayType": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "derivedFromVersionRef": "derivedFromVersionRef",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfTimeBands": {
            "changed": "changed",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "created": "created",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "id": "id",
            "members": [
              {
                "changed": "changed",
                "compatibleWithVersionRef": "compatibleWithVersionRef",
                "created": "created",
                "dayOffset": 1,
                "derivedFromVersionRef": "derivedFromVersionRef",
                "description": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "endTime": "11:11:11",
                "fareFrameRef": {
                  "nameOfClass": "nameOfClass",
                  "ref": "ref",
                  "version": "version"
                },
                "id": "NSB:Timeband:2HoursValidPlus1",
                "modification": "NEW",
                "name": [
                  {
                    "lang": "nob",
                    "value": "value"
                  }
                ],
                "nameOfClass": "TimeBand",
                "startTime": "11:11:11",
                "status": "DRAFT",
                "timeZone": "Europe/Oslo",
                "validityConditions": [
                  {
                    "changed": "changed",
                    "created": "created",
                    "fromDate": "fromDate",
                    "id": "NSB:ValidBetween:2018",
                    "modification": "NEW",
                    "nameOfClass": "ValidBetween",
                    "status": "DRAFT",
                    "toDate": "toDate",
                    "version": "NSB:Version:V1"
                  }
                ],
                "version": "NSB:Version:V1"
              }
            ],
            "modification": "NEW",
            "nameOfClass": "FareStructureElement",
            "status": "DRAFT",
            "validityConditions": [
              {
                "changed": "changed",
                "created": "created",
                "fromDate": "fromDate",
                "id": "NSB:ValidBetween:2018",
                "modification": "NEW",
                "nameOfClass": "ValidBetween",
                "status": "DRAFT",
                "toDate": "toDate",
                "version": "NSB:Version:V1"
              }
            ],
            "version": "NSB:Version:V1"
          },
          "id": "NSB:TemporalValidityParameter:OperatorNSB",
          "modification": "NEW",
          "nameOfClass": "TemporalValidityParameter",
          "status": "DRAFT",
          "validityCondition": {
            "changed": "changed",
            "created": "created",
            "fromDate": "fromDate",
            "id": "NSB:ValidBetween:2018",
            "modification": "NEW",
            "nameOfClass": "ValidBetween",
            "status": "DRAFT",
            "toDate": "toDate",
            "version": "NSB:Version:V1"
          },
          "validityConditionRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "version": "NSB:Version:V1"
        }
      ],
      "typeOfAccessRightAssignment": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "TypeOfAccessRightAssignment",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "validityParameterAssignmentType": "EQ",
      "validityParameterGroupingType": "AND",
      "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET",
      "validityParameters": [
        {
          "authorityRef": "NSB:Authority:NSB",
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "distributionChannelRef": "ENT:DistributionChannel:App",
          "facilitySetRef": "facilitySetRef",
          "fareClasses": [
            "string"
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "fareSectionRef": "fareSectionRef",
          "fareZoneRef": "KOL:FareZone:250",
          "genericParameterAssignmentRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
          "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
          "id": "NSB:ScopingValidityParameter:OperatorNSB",
          "lineRef": "lineRef",
          "lineType": "EXPRESS",
          "modification": "NEW",
          "nameOfClass": "ScopingValidityParameter",
          "operatorRef": "operatorRef",
          "placeUse": "START_AT",
          "scheduledStopPointRef": "scheduledStopPointRef",
          "status": "DRAFT",
          "tariffZoneRef": "RUT:TariffZone:2S",
          "topographicPlaceRef": "topographicPlaceRef",
          "transportSubmode": "expressBus",
          "vehicleMode": "AIR",
          "version": "NSB:Version:V1"
        }
      ],
      "version": "NSB:Version:V2"
    }
  ],
  "accessRightsInProduct": [
    {
      "accessNumber": 0,
      "accessNumberIsLimited": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:AccessRightInProduct:Ordinary",
      "isFirstInSequence": true,
      "isLastInSequence": true,
      "limitedAccessNumber": 0,
      "maximumAccess": 0,
      "minimumAccess": 0,
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "Refunding",
      "orderOfElement": 0,
      "preassignedFareProductRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "validableElementRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "version": "NSB:Version:V1"
    }
  ],
  "activeComparisonOperatorVariant": "E",
  "changed": "changed",
  "chargingMomentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "chargingMomentType": "BEFORE_TRAVEL",
  "conditionSummary": {
    "id": "NSB:ConditionSummary:1005TEN",
    "isExchangeable": true,
    "isRefundable": true
  },
  "created": "created",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareStructureType": "POINT_TO_POINT_FARE",
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "id": "NSB:SupplementProduct:BicycleReserving",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "SupplementProduct",
  "operatorRef": "RUT:Authority:RUT",
  "organisationRef": "ENT:Authority:ENT",
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "privateCode": "privateCode",
  "status": "DRAFT",
  "supplementProductType": "SEAT_RESERVATION",
  "typeOfFareProductRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "vatGroupRegister": "TRANSPORT_AND_TICKETS_VAT",
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

admin/bucket-invalidation

Did you find what you were looking for?