openapi: 3.2.0 info: title: Entur Geographical Intervals API version: 2026.10.0 description: 'Operations tagged geographical-intervals 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: geographical-intervals paths: /geographical-intervals: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' post: tags: - geographical-intervals summary: Create a GeographicalInterval operationId: geographical-intervals_create parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/GeographicalIntervalInsert' 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 /geographical-intervals/batch: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' put: tags: - geographical-intervals summary: Update multiple geographical intervals operationId: geographical-intervals_updateMany parameters: [] requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SeqGeographicalIntervalInsert' 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 post: tags: - geographical-intervals summary: Create a list of GeographicalIntervals operationId: geographical-intervals_createMany parameters: [] requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SeqGeographicalIntervalInsert' 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 /geographical-intervals/{giId}/fare-prices/{fpId}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' patch: tags: - geographical-intervals summary: Update price for a geographical interval by netexId operationId: geographical-intervals_updateFarePrice parameters: - name: giId in: path description: The id to identify a geographical interval required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: fpId in: path description: The id to identify a fare price required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: giVersionId in: query description: The version id to identify a geographical interval required: true style: form explode: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FarePriceUpdate' 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 /geographical-intervals/{id}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - geographical-intervals summary: Retrives a geographical interval by id operationId: geographical-intervals_getById parameters: - name: id in: path description: The unique id to identify a geographical interval 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 for the version of the geographical interval 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: 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 geographical interval content: application/json: schema: $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 /geographical-intervals/{id}/{version}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - geographical-intervals summary: Retrives a geographical interval by id and version operationId: geographical-intervals_getByIdAndVersion parameters: - name: id in: path description: The unique id to identify a geographical interval 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 for the version of the geographical interval 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: 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 geographical interval content: application/json: schema: $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/geographical-intervals/{id}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - geographical-intervals summary: Retrieves a geographical interval by id operationId: geographical-intervals_getByIdV2 parameters: - name: id in: path description: The unique id to identify a geographical interval 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: 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 geographical interval required: false style: form explode: true schema: type: string - name: fromDate in: query description: The from date of the geographical intervals version required: false style: form explode: true schema: type: string - name: toDate in: query description: The to date of the geographical intervals 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 geographical interval content: application/json: 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 components: schemas: 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. 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 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 SeqGeographicalIntervalInsert: type: object properties: empty: type: boolean traversableAgain: type: boolean 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 GeographicalIntervalInsert: required: - fareFrameRef - fareTableRefs - id - prices type: object properties: 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 numberOfUnits: type: number description: NumberOfUnits. format: double prices: type: array description: Prices for the fare. items: $ref: '#/components/schemas/FarePriceInsert' startGeographicalValue: type: integer description: StartGeographicalValue. format: int64 version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 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 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 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. FarePriceUpdate: type: object properties: amount: type: number description: Amount in the currency selected at create operation format: double examples: - 16.5 discountPercentageUsed: type: integer description: Discount in percentageUsed format: int32 examples: - 40 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 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 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