openapi: 3.2.0 info: title: Entur Capped Discount Rights API version: 2026.10.0 description: 'Operations tagged capped-discount-rights across 2 of this provider''s published API definitions: entur-products-openapi.json, entur-products-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment security: - jwt: [] tags: - name: capped-discount-rights paths: /capped-discount-rights: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - capped-discount-rights summary: Retrieves a capped discount right, filtered by given parameter(s) operationId: capped-discount-rights_getAll parameters: - name: orgId in: query description: The unique id to identify a organisation required: false style: form explode: true schema: type: string - name: fareFrameId in: query description: The unique id to identify data owned by organisation required: false style: form explode: true schema: type: string - name: languageCode in: query required: false style: form explode: true schema: type: string - name: gpaDataSet in: query description: 'Deprecated: this parameter is ignored. Only E-variant GPAs are returned.' required: false style: form explode: true schema: type: string - name: statusFilter in: query description: 'Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Mutually exclusive with validOnDate.' required: false style: form explode: true schema: type: array items: type: string examples: default: value: - DRAFT - PROPOSED - name: validOnDate in: query description: 'Return the CappedDiscountRights valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED CappedDiscountRights are returned. And in the staging environment, PROPOSED CappedDiscountRights are preferred to VERSIONED ones. Mutually exclusive with statusFilter.' required: false style: form explode: true schema: type: string - name: language in: query description: The unique id for the language required: false style: form explode: true schema: type: string - name: If-None-Match in: header description: 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. required: false style: simple explode: false schema: type: string responses: '200': description: Returns the info content: application/json: schema: type: array items: $ref: '#/components/schemas/CappedDiscountRight' '304': description: Not Modified '400': description: Bad Request content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Resource not found content: application/problem+json: schema: type: string '500': description: Internal server error content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:les post: tags: - capped-discount-rights summary: Create a capped discount right operationId: capped-discount-rights_create parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CappedDiscountRightInsert' required: true responses: '204': description: Entity created successfully '400': description: Validation errors content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Not Found content: application/problem+json: schema: type: string '409': description: Already registered content: application/problem+json: schema: type: string '500': description: Internal server error content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:endre servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment /capped-discount-rights/{id}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - capped-discount-rights summary: Retrieves a capped discount right by id. operationId: capped-discount-rights_getById parameters: - name: id in: path description: The unique id to identify the capped discount right required: true style: simple explode: false schema: type: string - name: version in: query description: The id of the version of the capped discount right required: false style: form explode: true schema: type: string - name: languageCode in: query description: The language code from ISO-639-3 required: false style: form explode: true schema: type: string - name: gpaDataSet in: query description: 'Deprecated: this parameter is ignored. Only E-variant GPAs are returned.' required: false style: form explode: true schema: type: string - name: findActiveInEnvironment in: query description: 'Deprecated: this parameter is ignored. The endpoint now returns the version valid today (environment-aware) by default.' required: false deprecated: true style: form explode: true schema: type: boolean - name: validOnDate in: query description: Return the version valid on the given date (ISO-8601). Overrides 'version'. In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED. required: false style: form explode: true schema: type: string format: date-time - name: If-None-Match in: header description: 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. required: false style: simple explode: false schema: type: string responses: '200': description: Returns the resource content: application/json: schema: $ref: '#/components/schemas/CappedDiscountRight' '304': description: Not Modified '400': description: Bad Request content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Resource not found content: application/problem+json: schema: type: string '500': description: Internal server error content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:les servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment /capped-discount-rights/{id}/{version}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - capped-discount-rights summary: Retrieves a capped discount right by id and version operationId: capped-discount-rights_getByIdAndVersion parameters: - name: id in: path description: The unique id to identify the capped discount right required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: version in: path description: The id of the version of the capped discount right required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: gpaDataSet in: query description: 'Deprecated: this parameter is ignored. Only E-variant GPAs are returned.' required: false style: form explode: true schema: type: string - name: Accept-Language in: header description: The language code from ISO-639-3 required: false style: simple explode: false schema: type: string - name: If-None-Match in: header description: 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. required: false style: simple explode: false schema: type: string responses: '200': description: Returns the resource content: application/json: schema: $ref: '#/components/schemas/CappedDiscountRight' '304': description: Not Modified '400': description: Bad Request content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Resource not found content: application/problem+json: schema: type: string '500': description: Internal server error content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:les put: tags: - capped-discount-rights summary: Update a capped discount right operationId: capped-discount-rights_update parameters: - name: id in: path description: The unique id to identify the capped discount right required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: version in: path description: The id of the version of the capped discount right required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CappedDiscountRightInsert' required: true responses: '204': description: Entity updated successfully '400': description: Validation errors content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Resource not found content: application/problem+json: schema: type: string '409': description: Already registered content: application/problem+json: schema: type: string '500': description: Internal server error content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:endre servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment components: schemas: TextInLanguage: required: - lang - value type: object properties: lang: minLength: 1 type: string description: Language code. examples: - nob value: minLength: 1 type: string description: The text. description: Text in a specific language. GroupOfTimeBands: required: - changed - created - id - members - modification - nameOfClass - status - validityConditions type: object properties: changed: type: string description: Changed datetime. compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. derivedFromVersionRef: type: string description: Derived from version. id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. members: type: array description: Members. items: $ref: '#/components/schemas/Timeband' modification: type: string description: Modification status. enum: - NEW - REVISE - DELETE examples: - NEW nameOfClass: type: string description: Name of class. examples: - FareStructureElement status: type: string description: Status. enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT validityConditions: type: array description: ValidityConditions sequence. items: $ref: '#/components/schemas/ValidityCondition' version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 description: A GroupOfTimeband describe during which the assignments applies ConditionSummary: required: - id type: object properties: id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:ConditionSummary:1005TEN isExchangeable: type: boolean description: Whether the ticket is exchangeable. examples: - true isRefundable: type: boolean description: Whether the ticket is refundable. examples: - true description: A summary of a condition. Rounding: required: - changed - created - fareFrameRef - id - modification - nameOfClass - roundingMethod - status - version type: object properties: changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:Rounding:Ordinary modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - Rounding roundingMethod: type: string description: Type of rounding. enum: - NONE - DOWN - UP - SPLIT - STEP_TABLE - FIVE - NINE - TEN - FORTY_NINE roundingModulus: type: number description: Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value. format: double status: type: string description: Rounding status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Rounding version. examples: - NSB:Version:V1 description: A description of how prices are rounded post calculation deprecated: true GenericParameterAssignment: required: - changed - created - fareFrameRef - id - modification - nameOfClass - status - version type: object properties: canIgnoreInOffering: type: boolean description: Indicates whether gpa leaf node is supposed to be ignored when generating offer. examples: - true changed: type: string description: Changed datetime. chargingBasisType: type: string description: ChargingBasisType. enum: - FREE - DISCOUNTED - NORMAL - ANY examples: - FREE comparisonOperatorVariant: type: string description: 'Deprecated: this parameter will be ignored' examples: - E compatibleWithVersionRef: type: string description: CompatibleWithVersionRef. examples: - NSB:Version:V1 created: type: string description: Created datetime. derivedFromVersionRef: type: string description: Derived from version. examples: - NSB:Version:V1 description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' fareProductRef: $ref: '#/components/schemas/VersionOfObjectRef' fareStructureElementRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:GenericParameterAssignment:AllowedOperators includes: type: array description: Includes genericParameterAssignments. items: $ref: '#/components/schemas/GenericParameterAssignment' includesGroupingType: type: string description: Includes grouping type. enum: - AND - OR - XOR - NOT examples: - AND limitationGroupingType: type: string description: Limitation grouping type. enum: - AND - OR - XOR - NOT examples: - AND limitations: type: array description: Limitations as UsageParameters. items: $ref: '#/components/schemas/VersionOfObjectRef' modification: type: string description: Modification status. enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class examples: - GenericParameterAssignment parentParameterAssignmentRef: $ref: '#/components/schemas/VersionOfObjectRef' requiredElements: type: array description: Required elements. items: type: string requiredInContext: type: string description: Required in context. enum: - OFFERING - BOOKING - RESERVATION - SALE - FULFILMENT - ACTIVATION - CONSUMPTION - REVALIDATION requiredType: type: string description: Required type. enum: - SERVICE_JOURNEY_REF - TARIFF_ZONE_REF - PASSENGER_SEAT_REF - USER_PROFILE_REF - USAGE_VALIDITY_PERIOD_REF - DATED_SERVICE_JOURNEY_REF - DYNAMIC_DISTANCE_MATRIX_ELEMENT - USAGE_VALIDITY_PERIOD - DISTANCE_MATRIX_ELEMENT_REF - SCHEDULED_STOP_POINT_REF - GROUP_TICKET_REF - GROUP_TICKET - GROUP_OF_TARIFF_ZONES_REF - FARE_ZONE_REF examples: - SERVICE_JOURNEY_REF salesPackageRef: $ref: '#/components/schemas/VersionOfObjectRef' status: type: string description: Status enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT temporalValidityParameters: type: array description: Temporal validity parameter. items: $ref: '#/components/schemas/TemporalValidityParameter' typeOfAccessRightAssignment: $ref: '#/components/schemas/TypeOfAccessRightAssignment' validableElementRef: $ref: '#/components/schemas/VersionOfObjectRef' validityParameterAssignmentType: type: string description: Validity parameter assignment type. enum: - EQ - NE - GT - LT - GE - LE examples: - EQ validityParameterGroupingType: type: string description: Validity parameter grouping type. enum: - AND - OR - XOR - NOT examples: - AND validityParameterSetSelectionType: type: string description: Validity parameter set operator. enum: - ONE_OF_ANY_ONE_SET - ONE_OF_EACH_SET - SOME_OF_ANY_SET - ALL_OF_ONE_SET - ALL_OF_ALL_SETS validityParameters: type: array description: Validity parameters as scoping validity parameters items: $ref: '#/components/schemas/ScopingValidityParameter' version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version examples: - NSB:Version:V2 description: A GenericParameterAssignment VersionOfObjectRef: required: - nameOfClass - ref - version type: object properties: nameOfClass: minLength: 1 type: string description: Name of class. ref: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: The netex id reference to the object. version: type: string description: Version. description: Fare frame ref. LimitingRule: required: - changed - created - fareFrameRef - id - modification - nameOfClass - status type: object properties: canBeCumulative: type: boolean description: CanBeCumulative. changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description. items: $ref: '#/components/schemas/TextInLanguage' discountAsPercentage: type: number description: DiscountAsPercentage. format: float discountAsValue: type: number description: DiscountAsValue. format: float fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. maximumPrice: type: string description: MaximumPrice. examples: - '164.0' maximumPriceAsPercentage: type: number description: MaximumPriceAsPercentage. format: double minimumLimitPrice: type: string description: MinimumLimitPrice. examples: - '164.0' minimumPrice: type: string description: MinimumPrice. examples: - '164.0' modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - LimitingRule status: type: string description: Status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 description: A LimitingRule CappedDiscountRightInsert: required: - chargingMomentRef - fareFrameRef - id - name - operatorRef - organisation - version type: object properties: accessRightParameterAssignmentRefs: type: array description: AccessRightParameterAssignments. items: $ref: '#/components/schemas/VersionOfObjectRef' accessRightsInProduct: type: array description: AccessRightsInProduct. items: $ref: '#/components/schemas/AccessRightInProductInsert' activeComparisonOperatorVariant: type: string description: 'Deprecated: this parameter is ignored.' examples: - E cappingRules: type: array description: Capping rules. items: $ref: '#/components/schemas/CappingRuleInsert' chargingMomentRef: $ref: '#/components/schemas/VersionOfObjectRef' chargingMomentType: type: string description: ChargingMomentType. Default value is BEFORE_TRAVEL. enum: - 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 - FREE - ANY_TIME - OTHER examples: - BEFORE_TRAVEL compatibleWithVersionRef: type: string description: Compatible with version. conditionSummary: $ref: '#/components/schemas/ConditionSummaryInsert' derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' fareStructureType: type: string description: FareStructureType. enum: - 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 - ZONE_FLAT_FARE - ZONE_SEQUENCE_FARE - ZONE_TO_ZONE_FARE - ZONE_COUNT_FARE - PENALTY_FARE - OTHER examples: - ZONE_TO_ZONE_FARE fareTableRefs: type: array description: FareTableRef. items: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - ENT:CappedDiscountRight:BestePrisFylket name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' operatorRef: type: string description: OperatorRef. examples: - RUT:Authority:RUT organisation: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Organisation. prices: type: array description: Prices. items: $ref: '#/components/schemas/FarePriceInsert' privateCode: type: string description: PrivateCode. typeOfFareProductRef: $ref: '#/components/schemas/VersionOfObjectRef' validationRequirements: type: array description: 'An optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED' items: type: string vatGroupRegister: type: string description: VatGroupRegister. default: TRANSPORT_AND_TICKETS_VAT enum: - EXCEPTION_FROM_VAT - GENERAL_VAT - FOOD_VAT - TRANSPORT_AND_TICKETS_VAT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 ConditionSummaryInsert: required: - id type: object properties: id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:ConditionSummary:1005TEN isExchangeable: type: boolean description: Whether the ticket is exchangeable. examples: - true isRefundable: type: boolean description: Whether the ticket is refundable. examples: - true description: ConditionSummary. Timeband: required: - changed - created - dayOffset - description - endTime - fareFrameRef - id - modification - name - nameOfClass - startTime - status type: object properties: changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. readOnly: true created: type: string description: Created datetime. readOnly: true dayOffset: type: integer description: Days offset. This will determine if endTime is x number of days from today. ie. 1 is tomorrow 0 is today. format: int32 examples: - 1 derivedFromVersionRef: type: string description: Derived from version. readOnly: true description: type: array description: Description represented in different languages. Language codes are ISO-639 items: $ref: '#/components/schemas/TextInLanguage' endTime: type: string description: End time. examples: - '11:11:11' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:Timeband:2HoursValidPlus1 modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: The name of the luggage allowance represented in different languages. Language codes are ISO-639 items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - TimeBand startTime: type: string description: Start time. examples: - '11:11:11' status: type: string description: Status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT timeZone: type: string description: Time zone. default: Europe/Oslo examples: - Europe/Oslo validityConditions: type: array description: ValidityConditions sequence. items: $ref: '#/components/schemas/ValidityCondition' version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 description: The TimeBand describe during which the assignment applies TypeOfAccessRightAssignment: required: - changed - created - fareFrameRef - id - modification - nameOfClass - status - version type: object properties: changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - TypeOfAccessRightAssignment status: type: string description: Type of access right assignment status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Type of access right assignment version. examples: - NSB:Version:V1 description: A classification of Access Right Assignments. ScopingValidityParameter: required: - changed - created - fareFrameRef - genericParameterAssignmentRef - id - modification - nameOfClass - status - version type: object properties: authorityRef: type: string description: AuthorityRef. examples: - NSB:Authority:NSB changed: type: string description: Changed datetime. compatibleWithVersionRef: type: string description: CompatibleWithVersionRef. created: type: string description: Created datetime. derivedFromVersionRef: type: string description: Derived from version. distributionChannelRef: type: string description: Distribution channel ref. examples: - ENT:DistributionChannel:App facilitySetRef: type: string description: facilitySetRef. fareClasses: type: array description: 'FareClasses. Enum as string with the following values: FIRST_CLASS, SECOND_CLASS, THIRD_CLASS, ECONOMY_CLASS, BUSINESS_CLASS, TURISTA, PREFERENTE, STANDARD_CLASS, PREMIUM_CLASS, ANY, UNKNOWN' items: type: string fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' fareSectionRef: type: string description: Fare section ref. fareZoneRef: type: string description: FareZoneRef. examples: - KOL:FareZone:250 genericParameterAssignmentRef: $ref: '#/components/schemas/VersionOfObjectRef' groupOfLinesRef: type: string description: Group of Lines ref. examples: - ENT:GroupOfLines:AllLines groupOfTariffZonesRef: type: string description: Group of Tariff Zones ref. examples: - ENT:GroupOfTariffZones:AllZones id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:ScopingValidityParameter:OperatorNSB lineRef: type: string description: LineRef. lineType: type: string description: LineType. enum: - LOCAL - URBAN - LONG_DISTANCE - EXPRESS - SEASONAL - REPLACEMENT - FLEXIBLE - CORRIDOR_SERVICE - MAIN_ROUTE_WITH_FLEXIBLE_ENDS - FLEXIBLE_AREAS_ONLY - HAIL_AND_RIDE_SECTIONS - FIXED_STOP_AREA_WIDE - FREE_AREA_AREA_WIDE - MIXED_FLEXIBLE - MIXED_FLEXIBLE_AND_FIXED - FIXED - OTHER examples: - EXPRESS modification: type: string description: Modification status. enum: - NEW - REVISE - DELETE examples: - NEW nameOfClass: type: string description: Name of class. examples: - ScopingValidityParameter operatorRef: type: string description: Operator referance. placeUse: type: string description: PlaceUse enum: - START_AT - END_AT - VIA - RESTRICT_TO - OTHER scheduledStopPointRef: type: string description: Scheduled stop Point ref. status: type: string description: Status enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT tariffZoneRef: type: string description: TariffZoneRef. This field is deprecated, please use the field FareZoneRef. deprecated: true examples: - RUT:TariffZone:2S topographicPlaceRef: type: string description: TopographicPlaceRef transportSubmode: type: string description: TransportSubmode. enum: - unknown - undefined - internationalFlight - domesticFlight - intercontinentalFlight - domesticScheduledFlight - shuttleFlight - intercontinentalCharterFlight - internationalCharterFlight - roundTripCharterFlight - sightseeingFlight - helicopterService - domesticCharterFlight - SchengenAreaFlight - airshipService - shortHaulInternationalFlight - canalBarge - localBus - regionalBus - expressBus - nightBus - postBus - specialNeedsBus - mobilityBus - mobilityBusForRegisteredDisabled - sightseeingBus - shuttleBus - highFrequencyBus - dedicatedLaneBus - schoolBus - schoolAndPublicServiceBus - railReplacementBus - demandAndResponseBus - airportLinkBus - internationalCoach - nationalCoach - shuttleCoach - regionalCoach - specialCoach - schoolCoach - sightseeingCoach - touristCoach - commuterCoach - funicular - streetCableCar - allFunicularServices - undefinedFunicular - metro - tube - urbanRailway - cityTram - localTram - regionalTram - sightseeingTram - shuttleTram - trainTram - telecabin - cableCar - lift - chairLift - dragLift - telecabinLink - local - highSpeedRail - suburbanRailway - regionalRail - interregionalRail - longDistance - international - sleeperRailService - nightRail - carTransportRailService - touristRailway - airportLinkRail - railShuttle - replacementRailService - specialTrain - crossCountryRail - rackAndPinionRailway - internationalCarFerry - nationalCarFerry - regionalCarFerry - localCarFerry - internationalPassengerFerry - nationalPassengerFerry - regionalPassengerFerry - localPassengerFerry - postBoat - trainFerry - roadFerryLink - airportBoatLink - highSpeedVehicleService - highSpeedPassengerService - sightseeingService - schoolBoat - cableFerry - riverBus - scheduledFerry - shuttleFerryService - communalTaxi - charterTaxi - waterTaxi - railTaxi - bikeTaxi - blackCab - miniCab - allTaxiServices - hireCar - hireVan - hireMotorbike - hireCycle - allHireVehicles examples: - expressBus vehicleMode: type: string description: VehicleModeRef. enum: - AIR - BUS - COACH - CABLE_WAY - WATER - FUNICULAR - LIFT - RAIL - METRO - TAXI - TRAM - UNKNOWN version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version examples: - NSB:Version:V1 description: A ScopingValidityParameter AccessRightInProductInsert: required: - fareFrameRef - id - preassignedFareProductRef - validableElementRef type: object properties: accessNumber: type: integer description: The actual access number format: int32 accessNumberIsLimited: type: boolean description: Flag indicating if access number is limited compatibleWithVersionRef: type: string description: Compatible with version. derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:AccessRightInProduct:Ordinary isFirstInSequence: type: boolean description: Whether element is first in sequence isLastInSequence: type: boolean description: Whether element is last in sequence maximumAccess: type: integer description: Maximum number of times use of this element may occur in a given trip format: int32 minimumAccess: type: integer description: Minimum number of times use of this element must occur in a given trip format: int32 name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' orderOfElement: type: integer description: The actual order in the sequence format: int32 preassignedFareProductRef: $ref: '#/components/schemas/VersionOfObjectRef' validableElementRef: $ref: '#/components/schemas/VersionOfObjectRef' ValidityCondition: required: - changed - created - id - modification - nameOfClass - status - version type: object properties: changed: type: string description: Changed datetime. readOnly: true created: type: string description: Created datetime. readOnly: true fromDate: type: string description: From Date. id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:ValidBetween:2018 modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW nameOfClass: type: string description: Name of class. readOnly: true examples: - ValidBetween status: type: string description: Status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT toDate: type: string description: To Date. version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 description: A condition of the validity of the priceable object CappingRuleInsert: required: - accessRightParameterAssignmentRefs - activeComparisonOperatorVariant - fareFrameRef - fareTableRefs - id - name - version type: object properties: accessRightParameterAssignmentRefs: type: array description: Access Right Parameter assignment references. items: $ref: '#/components/schemas/VersionOfObjectRef' activeComparisonOperatorVariant: type: string description: 'Deprecated: this parameter will be ignored.' examples: - E cappingPeriod: type: string description: Period over which capping applies. enum: - DAY - WEEK - MONTH examples: - DAY compatibleWithVersionRef: type: string description: Compatible with version. derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' fareTableRefs: type: array description: FareTableRef. items: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - ENT:CappingRule:EnkeltbillettTil24Timer name: type: array description: UserProfile Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' preassignedFareProductRef: $ref: '#/components/schemas/VersionOfObjectRef' prices: type: array description: Fare prices. items: $ref: '#/components/schemas/FarePrice' validableElementRef: $ref: '#/components/schemas/VersionOfObjectRef' version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 RoundingInsert: required: - fareFrameRef - id - roundingMethod - version type: object properties: description: type: array description: Description. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:Rounding:Ordinary name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' roundingMethod: type: string description: Type of rounding. enum: - NONE - DOWN - UP - SPLIT - STEP_TABLE - FIVE - NINE - TEN - FORTY_NINE roundingModulus: type: number description: Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value. format: double version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Rounding version. examples: - NSB:Version:V1 description: Rounding. deprecated: true FarePriceInsert: required: - fareFrameRef - id - name type: object properties: amount: type: string description: Amount. examples: - '164.0' canBeCumulative: type: boolean description: canBeCumulative. examples: - true compatibleWithVersionRef: type: string description: Compatible with version. currency: type: string description: Currency. examples: - NOK derivedFromVersionRef: type: string description: Derived from version. discountPercentageUsed: type: integer description: discountPercentageUsed. format: int32 examples: - 5 fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:FarePrice:1005TEN isAllowed: type: boolean description: isAllowed. examples: - true limitingRule: $ref: '#/components/schemas/LimitingRule' name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' ranking: type: integer description: Ranking. format: int32 examples: - 1 rounding: $ref: '#/components/schemas/RoundingInsert' roundingRef: $ref: '#/components/schemas/VersionOfObjectRef' vatRegisterGroup: type: string description: vatRegisterGroup. enum: - EXCEPTION_FROM_VAT - GENERAL_VAT - FOOD_VAT - TRANSPORT_AND_TICKETS_VAT examples: - TRANSPORT_AND_TICKETS_VAT version: type: string TypeOfFareProduct: required: - changed - created - fareFrameRef - id - nameOfClass - version type: object properties: changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:TypeOfFareProduct:Ordinary modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - TypeOfFareProduct status: type: string description: Type of fare product status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Type of fare product version. examples: - NSB:Version:V1 description: A classification of FARE PRODUCTs. CappedDiscountRight: required: - changed - chargingMoment - created - fareFrameRef - id - modification - nameOfClass - status - validityConditions - vatGroupRegister - version type: object properties: accessRightParameterAssignments: type: array description: AccessRightParameterAssignments. items: $ref: '#/components/schemas/GenericParameterAssignment' accessRightsInProduct: type: array description: AccessRightsInProduct. items: $ref: '#/components/schemas/AccessRightInProduct' activeComparisonOperatorVariant: type: string description: 'Deprecated: this parameter is ignored.' examples: - E cappingRules: type: array description: Capping rules. items: $ref: '#/components/schemas/CappingRule' changed: type: string description: Changed datetime. chargingMoment: $ref: '#/components/schemas/ChargingMoment' chargingMomentType: type: string description: ChargingMomentType. Default value is BEFORE_TRAVEL. enum: - 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 - FREE - ANY_TIME - OTHER examples: - BEFORE_TRAVEL compatibleWithVersionRef: type: string description: CompatibleWithVersionRef conditionSummary: $ref: '#/components/schemas/ConditionSummary' created: type: string description: Created datetime. derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' fareStructureType: type: string description: FareStructureType. enum: - 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 - ZONE_FLAT_FARE - ZONE_SEQUENCE_FARE - ZONE_TO_ZONE_FARE - ZONE_COUNT_FARE - PENALTY_FARE - OTHER examples: - ZONE_TO_ZONE_FARE fareTableRefs: type: array description: FareTableRef. items: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - ENT:CappedDiscountRight:BestePrisFylket limitingRuleRef: $ref: '#/components/schemas/VersionOfObjectRef' modification: type: string description: Modification status. enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. examples: - CappedDiscountRight operatorRef: type: string description: OperatorRef. examples: - RUT:Authority:RUT organisation: type: string description: Organisation who own the product. organisationId: type: string description: Organisation related to the userProfile prices: type: array description: Prices. items: $ref: '#/components/schemas/FarePrice' privateCode: type: string description: PrivateCode. status: type: string description: Status enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT typeOfFareProduct: $ref: '#/components/schemas/TypeOfFareProduct' validationRequirements: type: array description: 'An optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED' items: type: string validityConditions: type: array description: ValidityCondition. items: $ref: '#/components/schemas/ValidityCondition' vatGroupRegister: type: string description: VatGroupRegister. enum: - EXCEPTION_FROM_VAT - GENERAL_VAT - FOOD_VAT - TRANSPORT_AND_TICKETS_VAT examples: - TRANSPORT_AND_TICKETS_VAT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version examples: - NSB:Version:V1 description: A Capped Discount Right response FarePrice: required: - changed - created - fareFrameRef - id - modification - nameOfClass - status type: object properties: amount: type: string description: Amount examples: - '164.0' canBeCumulative: type: boolean description: canBeCumulative. examples: - true changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true currency: type: string description: Currency. examples: - NOK derivedFromVersionRef: type: string description: Derived from version. discountPercentageUsed: maximum: 100 minimum: -100 type: integer description: discountPercentageUsed. format: int32 examples: - 5 fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 type: string description: Id. examples: - NSB:FarePrice:1005TEN isAllowed: type: boolean description: isAllowed. examples: - true limitingRule: $ref: '#/components/schemas/LimitingRule' modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - FarePrice ranking: type: integer description: Ranking. format: int32 examples: - 1 rounding: $ref: '#/components/schemas/Rounding' roundingRef: $ref: '#/components/schemas/VersionOfObjectRef' status: type: string description: Status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT vatRegisterGroup: type: string description: vatRegisterGroup. enum: - EXCEPTION_FROM_VAT - GENERAL_VAT - FOOD_VAT - TRANSPORT_AND_TICKETS_VAT examples: - TRANSPORT_AND_TICKETS_VAT version: type: string description: Version. readOnly: true examples: - NSB:Version:V1 description: A description of the price and factor for a set fare ChargingMoment: required: - changed - created - fareFrameRef - id - modification - nameOfClass - status - version type: object properties: changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. readOnly: true created: type: string description: Created datetime. readOnly: true derivedFromVersionRef: type: string description: Derived from version. readOnly: true description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:ChargingMoment:Prepaid modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - ChargingMoment status: type: string description: Charging moment status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Charging moment version. examples: - NSB:Version:V1 description: 'A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.' readOnly: true deprecated: true AccessRightInProduct: required: - fareFrameRef - id - preassignedFareProductRef - validableElementRef - version type: object properties: accessNumber: type: integer description: The actual access number format: int32 accessNumberIsLimited: type: boolean description: Flag indicating if access number is limited changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:AccessRightInProduct:Ordinary isFirstInSequence: type: boolean description: Whether element is first in sequence isLastInSequence: type: boolean description: Whether element is last in sequence limitedAccessNumber: type: integer description: Flag indicating whether this rights gives an unlimited number of accesses or not format: int32 maximumAccess: type: integer description: Maximum number of times use of this element may occur in a given trip format: int32 minimumAccess: type: integer description: Minimum number of times use of this element must occur in a given trip format: int32 modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - Refunding orderOfElement: type: integer description: The actual order in the sequence format: int32 preassignedFareProductRef: $ref: '#/components/schemas/VersionOfObjectRef' status: type: string description: Access right in product status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT validableElementRef: $ref: '#/components/schemas/VersionOfObjectRef' version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Access right in product version. examples: - NSB:Version:V1 description: A VALIDABLE ELEMENT as a part of a PRE-ASSIGNED FARE PRODUCT, including its possible order in the set of all VALIDABLE ELEMENTs grouped together to define the access right assigned to that PRE-ASSIGNED FARE PRODUCT. CappingRule: required: - activeComparisonOperatorVariant - changed - created - fareFrameRef - id - modification - nameOfClass - status - version type: object properties: accessRightParameterAssignments: type: array description: Access Right Parameter assignments. items: $ref: '#/components/schemas/GenericParameterAssignment' activeComparisonOperatorVariant: type: string description: 'Deprecated: this parameter will be ignored.' examples: - E cappingPeriod: type: string description: Period over which capping applies. enum: - DAY - WEEK - MONTH examples: - DAY changed: type: string description: Changed datetime. format: date-time compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. format: date-time derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' fareTableRefs: type: array description: Reference to fare table. items: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - ENT:CappingRule:EnkeltbillettTil24Timer modification: type: string description: Modification status. enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. examples: - CappingRule preassignedFareProductRef: $ref: '#/components/schemas/VersionOfObjectRef' prices: type: array description: Prices for the fare. items: $ref: '#/components/schemas/FarePrice' status: type: string description: Status. enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT validableElementRef: $ref: '#/components/schemas/VersionOfObjectRef' validityConditions: type: array description: Validity conditions. items: $ref: '#/components/schemas/ValidityCondition' version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 TemporalValidityParameter: required: - changed - created - genericParameterAssignmentRef - id - modification - nameOfClass - status - version type: object properties: changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: CompatibleWithVersionRef created: type: string description: Created datetime. readOnly: true dayType: $ref: '#/components/schemas/VersionOfObjectRef' derivedFromVersionRef: type: string description: Derived from version. genericParameterAssignmentRef: $ref: '#/components/schemas/VersionOfObjectRef' groupOfTimeBands: $ref: '#/components/schemas/GroupOfTimeBands' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:TemporalValidityParameter:OperatorNSB modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW nameOfClass: type: string description: Name of class. examples: - TemporalValidityParameter status: type: string description: Status readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT validityCondition: $ref: '#/components/schemas/ValidityCondition' validityConditionRef: $ref: '#/components/schemas/VersionOfObjectRef' version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version examples: - NSB:Version:V1 description: A TemporalValidityParameter parameters: X-Correlation-Id: name: X-Correlation-Id in: header description: Correlation id required: false style: simple explode: false schema: type: string ET-Client-Name: name: ET-Client-Name in: header description: '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: `-`.' required: false style: simple explode: false schema: type: string securitySchemes: jwt: type: http scheme: bearer bearerFormat: JWT x-refined-from: - entur-products-openapi.json - entur-products-openapi.yml