openapi: 3.2.0
info:
  title: Entur Fare Structure Elements API
  version: 2026.10.0
  description: 'Operations tagged fare-structure-elements 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: fare-structure-elements
paths:
  /fare-structure-elements:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - fare-structure-elements
      summary: Retrieves a preassignedFareProduct by organisation id
      operationId: fare-structure-elements_getAll
      parameters:
      - name: orgId
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: fareFrameId
        in: query
        description: The unique id to identify a dataset for an organization
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: languageCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: statusFilter
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SeqStatusFilterEnum'
      - 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: 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:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FareStructureElement'
        '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:
      - fare-structure-elements
      summary: Create a Fare structure element
      operationId: fare-structure-elements_create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FareStructureElementInsert'
        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
  /fare-structure-elements/count:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - fare-structure-elements
      summary: Retrieves the total number of fare structure elements.
      operationId: fare-structure-elements_getCount
      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 idetify data owned by organisation
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: statusFilter
        in: query
        description: 'Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. 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: 'Count FareStructureElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED FareStructureElements are counted. And in the staging environment, PROPOSED FareStructureElements are preferred to VERSIONED ones. Mutually exclusive with statusFilter.'
        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: Entity updated successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Count'
        '304':
          description: Not Modified
        '400':
          description: Validation errors
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Missing Authorization
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Authorization failed
          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
  /fare-structure-elements/pages:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - fare-structure-elements
      summary: Retrieves fareStructureElements for a given page.
      operationId: fare-structure-elements_findPageByOrganisationIdOrFareFrameId
      parameters:
      - name: orgId
        in: query
        description: The unique id to identify data owned by 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: 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: languageCode
        in: query
        description: The language code from ISO-639-3
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: Number of elements listed in requested page
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: The given page one want in return
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: statusFilter
        in: query
        description: 'Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. 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 FareStructureElements valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED FareStructureElements are returned. And in the staging environment, PROPOSED FareStructureElements are preferred to VERSIONED ones. Mutually exclusive with statusFilter.'
        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:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FareStructureElementPageWrapper'
        '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
  /fare-structure-elements/{id}:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - fare-structure-elements
      summary: Retrives a fare structure element by netexId
      operationId: fare-structure-elements_getById
      parameters:
      - name: id
        in: path
        description: The unique id to identify a fare structure element
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: version
        in: query
        description: The id of the version of the fare structure element
        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: 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:
            '*/*':
              schema:
                $ref: '#/components/schemas/FareStructureElement'
        '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
  /fare-structure-elements/{id}/{version}:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - fare-structure-elements
      summary: Retrives a fare structure element by id and version
      operationId: fare-structure-elements_getByIdAndVersion
      parameters:
      - name: id
        in: path
        description: The unique id to identify a fare structure element
        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 fare structure element
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: Languagecode
        in: header
        required: false
        style: simple
        explode: false
        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: 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:
            '*/*':
              schema:
                $ref: '#/components/schemas/FareStructureElement'
        '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:
      - fare-structure-elements
      summary: Update a fare structure element
      operationId: fare-structure-elements_update
      parameters:
      - name: id
        in: path
        description: The unique id to identify a fare structure element
        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 fare structure element
        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/FareStructureElementInsert'
        required: true
      responses:
        '204':
          description: Entity updated successfully
        '400':
          description: Validation errors
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Missing Authorization
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Authorization failed
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found
          content:
            application/problem+json:
              schema:
                type: string
        '409':
          description: Conflict
          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
  /fare-structure-elements/{id}/{version}/distance-matrix-elements:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - fare-structure-elements
      summary: Retrieves the distance matrix elements of the fare structure element
      description: No longer in use. DMEs are connected by geographicalStructureFactors
      operationId: fare-structure-elements_getPointToPointFares
      parameters:
      - name: id
        in: path
        description: The unique id to identify a fare structure element
        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 fare structure element
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          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: limit
        in: query
        description: The limited numbers of distance matrix elements returned in the set
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: The offset of distance matrix elements returned in the set
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - 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:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DistanceMatrixElement'
        '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
      deprecated: true
      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
  /fare-structure-elements/{id}/{version}/geographical-intervals:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - fare-structure-elements
      summary: Retrieves the geographical intervals of the fare structure element
      operationId: fare-structure-elements_getGeographicalIntervals
      parameters:
      - name: id
        in: path
        description: The unique id to identify a fare structure element
        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 fare structure element
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          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: limit
        in: query
        description: The limited numbers of geographical intervals returned in the set
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: The offset of geographical intervals returned in the set
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - 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:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeographicalInterval'
        '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
  /v1/fare-structure-elements/{id}:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - fare-structure-elements
      summary: Retrieves a fare structure element by netexId
      operationId: fare-structure-elements_getByIdV2
      parameters:
      - name: id
        in: path
        description: The unique id to identify a fare structure element
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: Languagecode
        in: header
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: startDate
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: endDate
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: The version status of the fare structure element
        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: Accept-Language
        in: header
        description: The language code from ISO-639-3
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: fromDate
        in: query
        description: The from date of the fare structure elements version
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: toDate
        in: query
        description: The to date of the fare structure elements version
        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:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FareStructureElement'
        '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
components:
  schemas:
    SeqStatusFilterEnum:
      type: object
      properties:
        empty:
          type: boolean
        traversableAgain:
          type: boolean
    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
    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.
    DistanceMatrixElement:
      required:
      - changed
      - created
      - fareFrameRef
      - id
      - nameOfClass
      - version
      type: object
      properties:
        changed:
          type: string
          description: Changed datetime.
          readOnly: true
        created:
          type: string
          description: Created datetime.
          readOnly: true
        description:
          type: array
          description: Description represented in different languages. Language codes are ISO-639.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        distance:
          type: number
          description: Distance.
          format: double
          examples:
          - 16.4
        endFareZoneRef:
          type: string
          description: End fare zone reference.
        endScheduledStopPointId:
          type: string
          description: End scheduled stop point netexId.
        endTariffZoneId:
          type: string
          description: End tariff zone reference. This field is deprecated, please use the field endFareZoneRef.
          deprecated: true
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        fareTableRefs:
          type: array
          description: References to fare tables that provide prices or discounts for the user profile.
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        groupId:
          type: integer
          description: Group id.
          format: int64
          examples:
          - 4
        groupRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id.
          examples:
          - NSB:DistanceMatrixElement:NSR167ToNSR359
        inverseAllowed:
          type: boolean
          description: Inverse is allowed.
          examples:
          - true
        isDirect:
          type: boolean
          description: Is a direct route.
          examples:
          - true
        limitingRuleRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        name:
          type: array
          description: DistanceMatrixElement 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:
          - DistanceMatrixElement
        prices:
          type: array
          description: Fare prices for the user profile.
          items:
            $ref: '#/components/schemas/FarePrice'
        relativeRanking:
          type: integer
          description: Relative ranking.
          format: int32
          examples:
          - 2
        startFareZoneRef:
          type: string
          description: Start fare zone reference.
        startScheduledStopPointId:
          type: string
          description: Start scheduled stop point netexId.
        startTariffZoneId:
          type: string
          description: Start tariff zone reference. This field is deprecated, please use the field startFareZoneRef.
          deprecated: true
        tariffId:
          type: integer
          description: Tariff id.
          format: int64
        tariffRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        validityConditions:
          type: array
          description: Validity conditions for the user profile.
          items:
            $ref: '#/components/schemas/ValidityCondition'
        version:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: DistanceMatrixElement version.
          examples:
          - NSB:Version:V1
      description: A DistanceMatrixElement
    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
    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
    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
    FareStructureElementInsert:
      required:
      - fareFrameRef
      - fareTableRefs
      - geographicalIntervalRefs
      - id
      - parameterAssignmentRefs
      type: object
      properties:
        activeComparisonOperatorVariant:
          type: string
          description: 'Deprecated: this parameter will be ignored'
          examples:
          - E
        description:
          type: array
          description: Description.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        fareTableRefs:
          type: array
          description: fare table reference
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        geographicalIntervalRefs:
          type: array
          description: geographical interval sequence
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        geographicalStructureFactorId:
          type: string
          description: Geographical structure factor id
          examples:
          - NSB:GeographicalStructureFactor:TENPrices
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id.
          examples:
          - NSB:FareStructureElement:TENInterval
        name:
          type: array
          description: Name.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        parameterAssignmentRefs:
          type: array
          description: Access Right Parameter assignments.
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        pointToPointFareRefs:
          type: array
          description: Field is deprecated. Use 'geographical structure factor' instead to connect 'distance matrix elements' to 'fare structure element'
          deprecated: true
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        prices:
          type: array
          description: Fare prices.
          items:
            $ref: '#/components/schemas/FarePriceInsert'
        tariffBasis:
          type: string
          description: Tariff basis.
          enum:
          - FLAT
          - DISTANCE
          - UNIT_SECTION
          - ZONE
          - ZONE_TO_ZONE
          - POINT_TO_POINT
          - ROUTE
          - TOUR
          - GROUP
          - DISCOUNT
          - PERIOD
          - FREE
          - OTHER
          examples:
          - DISTANCE
        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
    FareStructureElement:
      required:
      - changed
      - created
      - fareFrameRef
      - fareTableRefs
      - geographicalIntervalRefs
      - geographicalStructureFactorRefs
      - id
      - modification
      - nameOfClass
      - parameterAssignments
      - pointToPointFareRefs
      - qualityStructureFactorRefs
      - status
      - validityConditions
      type: object
      properties:
        activeComparisonOperatorVariant:
          type: string
          description: 'Deprecated: this parameter will be ignored'
          examples:
          - E
        changed:
          type: string
          description: Changed datetime.
          format: date-time
        created:
          type: string
          description: Created datetime.
          format: date-time
        description:
          type: array
          description: Description.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        fareTableRefs:
          type: array
          description: fare table reference
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        geographicalIntervalRefs:
          type: array
          description: geographical interval sequence
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        geographicalStructureFactorRefs:
          type: array
          description: geographical structure factor refs
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id.
          examples:
          - NSB:FareStructureElement:TENInterval
        limitingRule:
          $ref: '#/components/schemas/LimitingRule'
        modification:
          type: string
          description: Modification status.
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: Name.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class.
          examples:
          - FareStructureElement
        organisationId:
          type: string
          description: Organisation related to the userProfile
          readOnly: true
        parameterAssignments:
          type: array
          description: Access Right Parameter assignments.
          items:
            $ref: '#/components/schemas/GenericParameterAssignment'
        pointToPointFareRefs:
          type: array
          description: Field is deprecated. Distance matrix elements should be connected by a 'geographical structure factor'
          deprecated: true
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        prices:
          type: array
          description: Fare prices.
          items:
            $ref: '#/components/schemas/FarePrice'
        qualityStructureFactorRefs:
          type: array
          description: quality structure factor refs
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        status:
          type: string
          description: Status.
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        tariffBasis:
          type: string
          description: Tariff basis.
          enum:
          - FLAT
          - DISTANCE
          - UNIT_SECTION
          - ZONE
          - ZONE_TO_ZONE
          - POINT_TO_POINT
          - ROUTE
          - TOUR
          - GROUP
          - DISCOUNT
          - PERIOD
          - FREE
          - OTHER
          examples:
          - DISTANCE
        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 element describing the response structure of the fare
    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
    FareStructureElementPageWrapper:
      required:
      - items
      - requestedPageNumber
      - totalNumberOfItems
      - totalNumberOfPages
      type: object
      properties:
        items:
          type: array
          description: Fare structure elements for the given page
          readOnly: true
          items:
            $ref: '#/components/schemas/FareStructureElement'
        requestedPageNumber:
          type: integer
          description: Number of the requested page. In case state is lost
          format: int32
          examples:
          - 369
        totalNumberOfItems:
          type: integer
          description: Total number of items.
          format: int32
          examples:
          - 369
        totalNumberOfPages:
          type: integer
          description: Number of pages needed to traverse all items.
          format: int32
          readOnly: true
          examples:
          - 15
      description: FareTablePageWrapper
    Count:
      required:
      - numberOfElements
      type: object
      properties:
        numberOfElements:
          type: integer
          description: number of elements
          format: int32
          examples:
          - 369
      description: Count
    GeographicalInterval:
      required:
      - changed
      - created
      - fareFrameRef
      - id
      - 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.
        endGeographicalValue:
          type: integer
          description: endGeographicalValue.
          format: int64
        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:
          - NSB:GeographicalInterval:1364TEN
        intervalType:
          type: string
          description: intervalType.
          enum:
          - STOP
          - TARIFF_ZONE
          - DISTANCE
          - COUPON
          - OTHER
        limitingRule:
          $ref: '#/components/schemas/LimitingRule'
        modification:
          type: string
          description: Modification status.
          readOnly: true
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        nameOfClass:
          type: string
          description: Name of class.
          readOnly: true
          examples:
          - GeographicalInterval
        numberOfUnits:
          type: number
          description: numberOfUnits.
          format: double
        prices:
          type: array
          description: Prices for the fare.
          items:
            $ref: '#/components/schemas/FarePrice'
        startGeographicalValue:
          type: integer
          description: startGeographicalValue.
          format: int64
        status:
          type: string
          description: Status.
          readOnly: true
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        validityConditions:
          type: array
          description: validityConditions.
          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: GeographicalInterval
    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: `<company>-<application>`.'
      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