openapi: 3.2.0
info:
title: Entur Fare Zones API
version: 2026.05.0
contact:
name: Entur API Support
url: https://developer.entur.org
description: 'Operations tagged Fare Zones across 2 of this provider''s published API definitions: entur-stop-place-v1-read-openapi.json, entur-stop-place-v1-read-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.entur.io/stop-places/v1/read
tags:
- name: Fare Zones
description: Access fare zone definitions and boundaries used for ticket pricing calculations. Query by authority or specific zones.
paths:
/fare-zones:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Fare Zones
summary: List fare zones
description: Retrieves a paginated list of fare zones. Fare zones define geographic areas used for fare calculation and ticket pricing in public transport systems. Supports both JSON (default) and XML formats via Accept header.
operationId: getFareZones
parameters:
- name: count
in: query
description: Maximum number of results to return per page. Supported up to 1000; larger values are best-effort and may be limited or rejected — page with skip/count or use the bulk NeTEx export for the full dataset.
required: false
style: form
explode: true
schema:
type: integer
format: int32
default: 10
example: 10
- name: skip
in: query
description: Number of results to skip for pagination
required: false
style: form
explode: true
schema:
type: integer
format: int32
default: 0
example: 0
- name: ids
in: query
description: Filter by specific fare zone IDs
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: authorityRefs
in: query
description: Filter by transport authority references
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Successfully retrieved list of fare zones
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FareZone'
examples:
Fare Zones List:
summary: Example list of fare zones
description: Fare Zones List
value:
- id: RUT:FareZone:1
version: '2'
name:
value: Sone 1
lang: nor
transportOrganisationRef:
ref: RUT:Authority:RUT
scopingMethod: EXPLICIT_STOPS
- id: RUT:FareZone:2V
version: '1'
name:
value: Sone 2V
lang: nor
transportOrganisationRef:
ref: RUT:Authority:RUT
application/xml:
schema:
$ref: '#/components/schemas/FareZonesInFrame_RelStructure'
examples:
Fare Zones XML:
summary: Example list in NeTEx XML format
description: Fare Zones XML
value: "\n\n \n Sone 1\n \n explicitStops\n \n\n"
'400':
description: Invalid parameters
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FareZone'
servers:
- url: https://api.entur.io/stop-places/v1/read
/fare-zones/{id}:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Fare Zones
summary: Get fare zone by ID
description: Retrieves detailed information about a specific fare zone including boundaries, member stop places, and authority information. Supports both JSON (default) and XML formats via Accept header.
operationId: getFareZoneById
parameters:
- name: id
in: path
description: Unique identifier for the fare zone
required: true
style: simple
explode: false
schema:
type: string
example: RUT:FareZone:1
responses:
'200':
description: Successfully retrieved fare zone
content:
application/json:
schema:
$ref: '#/components/schemas/FareZone'
examples:
Fare Zone:
summary: Example fare zone
description: Fare Zone
value:
id: RUT:FareZone:1
version: '2'
name:
value: Sone 1
lang: nor
transportOrganisationRef:
ref: RUT:Authority:RUT
scopingMethod: EXPLICIT_STOPS
members:
scheduledStopPointRef:
- ref: NSR:ScheduledStopPoint:1
- ref: NSR:ScheduledStopPoint:2
application/xml:
schema:
$ref: '#/components/schemas/FareZone'
examples:
Fare Zone XML:
summary: Example in NeTEx XML format
description: Fare Zone XML
value: "\n\n Sone 1\n \n explicitStops\n \n \n \n\n"
'404':
description: Fare zone not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FareZone'
servers:
- url: https://api.entur.io/stop-places/v1/read
/fare-zones/{id}/versions:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Fare Zones
summary: List fare zone versions
description: Retrieves all historical versions of a specific fare zone. Tracks changes to zone boundaries, pricing structures, or member stop places. Supports both JSON (default) and XML formats via Accept header.
operationId: getFareZoneVersions
parameters:
- name: id
in: path
description: Unique identifier for the fare zone
required: true
style: simple
explode: false
schema:
type: string
example: RUT:FareZone:1
responses:
'200':
description: Successfully retrieved fare zone versions
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FareZone'
examples:
Fare Zone Versions:
summary: Example list of fare zone versions
description: Fare Zone Versions
value:
- id: RUT:FareZone:1
version: '2'
name:
value: Zone 1
lang: nor
transportOrganisationRef:
ref: RUT:Authority:RUT
- id: RUT:FareZone:1
version: '1'
name:
value: Zone 1
lang: nor
transportOrganisationRef:
ref: RUT:Authority:RUT
application/xml:
schema:
$ref: '#/components/schemas/FareZonesInFrame_RelStructure'
examples:
Fare Zone Versions XML:
summary: Example list of fare zone versions in NeTEx XML format
description: Fare Zone Versions XML
value: "\n\n \n Zone 1\n \n \n \n Zone 1\n \n \n\n"
'404':
description: Fare zone not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FareZone'
servers:
- url: https://api.entur.io/stop-places/v1/read
/fare-zones/{id}/versions/{version}:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Fare Zones
summary: Get specific fare zone version
description: Retrieves a specific historical version of a fare zone by ID and version number. Supports both JSON (default) and XML formats via Accept header.
operationId: getFareZoneVersion
parameters:
- name: id
in: path
description: Unique identifier for the fare zone
required: true
style: simple
explode: false
schema:
type: string
example: RUT:FareZone:1
- name: version
in: path
description: Version number
required: true
style: simple
explode: false
schema:
type: string
example: 2
responses:
'200':
description: Successfully retrieved fare zone version
content:
application/json:
schema:
$ref: '#/components/schemas/FareZone'
examples:
Fare Zone Version:
summary: Example specific fare zone version
description: Fare Zone Version
value:
id: RUT:FareZone:1
version: '1'
name:
value: Zone 1
lang: nor
transportOrganisationRef:
ref: RUT:Authority:RUT
application/xml:
schema:
$ref: '#/components/schemas/FareZone'
examples:
Fare Zone Version XML:
summary: Example specific fare zone version in NeTEx XML format
description: Fare Zone Version XML
value: "\n\n Zone 1\n \n\n"
'404':
description: Fare zone or version not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FareZone'
servers:
- url: https://api.entur.io/stop-places/v1/read
/tariff-zones:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Fare Zones
summary: List tariff zones (deprecated)
description: 'Retrieves a paginated list of tariff zones. DEPRECATED: Use /fare-zones instead. Supports both JSON (default) and XML formats via Accept header.'
operationId: getTariffZones
parameters:
- name: count
in: query
description: Maximum number of results to return per page. Supported up to 1000; larger values are best-effort and may be limited or rejected — page with skip/count or use the bulk NeTEx export for the full dataset.
required: false
style: form
explode: true
schema:
type: integer
format: int32
default: 10
example: 10
- name: skip
in: query
description: Number of results to skip for pagination
required: false
style: form
explode: true
schema:
type: integer
format: int32
default: 0
example: 0
- name: ids
in: query
description: Filter by specific tariff zone IDs
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: authorityRefs
in: query
description: Filter by transport authority references
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Successfully retrieved list of tariff zones
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TariffZone'
application/xml: {}
'400':
description: Invalid parameters
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TariffZone'
deprecated: true
servers:
- url: https://api.entur.io/stop-places/v1/read
/tariff-zones/{id}:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Fare Zones
summary: Get tariff zone by ID (deprecated)
description: 'Retrieves detailed information about a specific tariff zone. DEPRECATED: Use /fare-zones/{id} instead. Supports both JSON (default) and XML formats via Accept header.'
operationId: getTariffZoneById
parameters:
- name: id
in: path
description: Unique identifier for the tariff zone
required: true
style: simple
explode: false
schema:
type: string
example: RUT:TariffZone:1
responses:
'200':
description: Successfully retrieved tariff zone
content:
application/json:
schema:
$ref: '#/components/schemas/TariffZone'
application/xml: {}
'404':
description: Tariff zone not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/TariffZone'
deprecated: true
servers:
- url: https://api.entur.io/stop-places/v1/read
/tariff-zones/{id}/versions:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Fare Zones
summary: List tariff zone versions (deprecated)
description: 'Retrieves all historical versions of a specific tariff zone. DEPRECATED: Use /fare-zones/{id}/versions instead. Supports both JSON (default) and XML formats via Accept header.'
operationId: getTariffZoneVersions
parameters:
- name: id
in: path
description: Unique identifier for the tariff zone
required: true
style: simple
explode: false
schema:
type: string
example: RUT:TariffZone:1
responses:
'200':
description: Successfully retrieved tariff zone versions
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TariffZone'
application/xml: {}
'404':
description: Tariff zone not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TariffZone'
deprecated: true
servers:
- url: https://api.entur.io/stop-places/v1/read
/tariff-zones/{id}/versions/{version}:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Fare Zones
summary: Get specific tariff zone version (deprecated)
description: 'Retrieves a specific historical version of a tariff zone. DEPRECATED: Use /fare-zones/{id}/versions/{version} instead. Supports both JSON (default) and XML formats via Accept header.'
operationId: getTariffZoneVersion
parameters:
- name: id
in: path
description: Unique identifier for the tariff zone
required: true
style: simple
explode: false
schema:
type: string
example: RUT:TariffZone:1
- name: version
in: path
description: Version number
required: true
style: simple
explode: false
schema:
type: string
example: 2
responses:
'200':
description: Successfully retrieved tariff zone version
content:
application/json:
schema:
$ref: '#/components/schemas/TariffZone'
application/xml: {}
'404':
description: Tariff zone or version not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/TariffZone'
deprecated: true
servers:
- url: https://api.entur.io/stop-places/v1/read
components:
schemas:
LocationStructure:
type: object
properties:
altitude:
type: number
xml:
name: Altitude
id:
type: string
xml:
attribute: true
latitude:
type: number
xml:
name: Latitude
longitude:
type: number
xml:
name: Longitude
pos:
$ref: '#/components/schemas/DirectPositionType'
xml:
namespace: http://www.opengis.net/gml/3.2
precision:
type: number
xml:
name: Precision
srsName:
type: string
xml:
attribute: true
MultilingualString:
type: object
properties:
lang:
type: string
xml:
attribute: true
textIdType:
type: string
xml:
attribute: true
value:
type: string
TypeOfZoneRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
JAXBElementAbstractRingType:
type: object
properties:
globalScope:
type: boolean
name:
type: object
properties:
localPart:
type: string
namespaceURI:
type: string
prefix:
type: string
nil:
type: boolean
typeSubstituted:
type: boolean
value:
$ref: '#/components/schemas/AbstractRingType'
AbstractSurfaceType:
type: object
properties:
descriptionReference:
$ref: '#/components/schemas/ReferenceType'
id:
type: string
xml:
namespace: http://www.opengis.net/gml/3.2
attribute: true
identifier:
$ref: '#/components/schemas/CodeWithAuthorityType'
name:
type: array
items:
$ref: '#/components/schemas/CodeType'
srsDimension:
type: integer
xml:
attribute: true
srsName:
type: string
xml:
attribute: true
PointRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
ValidityConditionRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
JAXBElementAbstractSurfaceType:
type: object
properties:
globalScope:
type: boolean
name:
type: object
properties:
localPart:
type: string
namespaceURI:
type: string
prefix:
type: string
nil:
type: boolean
typeSubstituted:
type: boolean
value:
$ref: '#/components/schemas/AbstractSurfaceType'
AlternativeText:
type: object
properties:
alternativeTexts: {}
attributeName:
type: string
xml:
attribute: true
changed:
type: string
format: date-time
xml:
attribute: true
compatibleWithVersionFrameVersionRef:
type: string
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
dataManagedObjectRef:
$ref: '#/components/schemas/VersionOfObjectRefStructure'
xml:
name: DataManagedObjectRef
dataSourceRef:
type: string
xml:
attribute: true
derivedFromObjectRef:
type: string
xml:
attribute: true
derivedFromVersionRef_BasicModificationDetailsGroup:
type: string
xml:
name: derivedFromVersionRef
attribute: true
extensions:
$ref: '#/components/schemas/ExtensionsStructure'
xml:
name: Extensions
id:
type: string
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfClass:
type: string
xml:
attribute: true
order:
type: integer
xml:
attribute: true
publication:
type: string
enum:
- PUBLIC
- RESTRICTED
- PRIVATE
- CONFIDENTIAL
- AUTHORISED
- TEST
xml:
attribute: true
status_BasicModificationDetailsGroup:
type: string
enum:
- ACTIVE
- INACTIVE
- OTHER
xml:
name: status
attribute: true
text:
$ref: '#/components/schemas/MultilingualString'
xml:
name: Text
useForLanguage:
type: string
xml:
attribute: true
validBetween:
type: array
items:
$ref: '#/components/schemas/ValidBetween'
xml:
name: ValidBetween
validityConditions:
$ref: '#/components/schemas/ValidityConditions_RelStructure'
version:
type: string
xml:
attribute: true
required:
- text
ValidityConditions_RelStructure:
type: object
properties:
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
validityConditionRefOrValidBetweenOrValidityCondition_:
type: array
items: {}
PurposeOfGroupingRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
GroupOfOperatorsRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfMemberClass:
type: string
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
SimplePoint_VersionStructure:
type: object
properties:
alternativeTexts:
$ref: '#/components/schemas/AlternativeTexts_RelStructure'
changed:
type: string
format: date-time
xml:
attribute: true
compatibleWithVersionFrameVersionRef:
type: string
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
dataSourceRef:
type: string
xml:
attribute: true
derivedFromObjectRef:
type: string
xml:
attribute: true
derivedFromVersionRef_BasicModificationDetailsGroup:
type: string
xml:
name: derivedFromVersionRef
attribute: true
id:
type: string
xml:
attribute: true
location:
$ref: '#/components/schemas/LocationStructure'
xml:
name: Location
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
name:
$ref: '#/components/schemas/MultilingualString'
xml:
name: Name
nameOfClass:
type: string
xml:
attribute: true
publication:
type: string
enum:
- PUBLIC
- RESTRICTED
- PRIVATE
- CONFIDENTIAL
- AUTHORISED
- TEST
xml:
attribute: true
status_BasicModificationDetailsGroup:
type: string
enum:
- ACTIVE
- INACTIVE
- OTHER
xml:
name: status
attribute: true
validBetween:
type: array
items:
$ref: '#/components/schemas/ValidBetween'
xml:
name: ValidBetween
validityConditions:
$ref: '#/components/schemas/ValidityConditions_RelStructure'
version:
type: string
xml:
attribute: true
Projections_RelStructure:
type: object
properties:
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
projectionRefOrProjection:
type: array
items:
$ref: '#/components/schemas/JAXBElementObject'
ErrorResponse:
type: object
description: Error response returned when a request fails
properties:
details:
type: object
additionalProperties: {}
description: Additional error context
errorCode:
type: string
description: Machine-readable error code
example: RESOURCE_NOT_FOUND
message:
type: string
description: Human-readable error message
example: Resource not found
xml:
name: error
FareSections_RelStructure:
type: object
properties:
fareSectionRefOrFareSection:
type: array
items: {}
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
DirectPositionType:
type: object
properties:
srsDimension:
type: integer
xml:
attribute: true
srsName:
type: string
xml:
attribute: true
value:
type: array
items:
type: number
format: double
AbstractRingPropertyType:
type: object
properties:
abstractRing:
$ref: '#/components/schemas/JAXBElementAbstractRingType'
AbstractRingType: {}
KeyValueStructure:
type: object
properties:
key:
type: string
xml:
name: Key
typeOfKey:
type: string
xml:
attribute: true
value:
type: string
xml:
name: Value
required:
- key
- value
PolygonType:
type: object
properties:
descriptionReference:
$ref: '#/components/schemas/ReferenceType'
exterior:
$ref: '#/components/schemas/AbstractRingPropertyType'
id:
type: string
xml:
namespace: http://www.opengis.net/gml/3.2
attribute: true
identifier:
$ref: '#/components/schemas/CodeWithAuthorityType'
interior:
type: array
items:
$ref: '#/components/schemas/AbstractRingPropertyType'
name:
type: array
items:
$ref: '#/components/schemas/CodeType'
srsDimension:
type: integer
xml:
attribute: true
srsName:
type: string
xml:
attribute: true
TariffZone:
type: object
properties:
alternativeTexts:
$ref: '#/components/schemas/AlternativeTexts_RelStructure'
brandingRef:
$ref: '#/components/schemas/BrandingRefStructure'
xml:
name: BrandingRef
centroid:
$ref: '#/components/schemas/SimplePoint_VersionStructure'
xml:
name: Centroid
changed:
type: string
format: date-time
xml:
attribute: true
compatibleWithVersionFrameVersionRef:
type: string
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
dataSourceRef:
type: string
xml:
attribute: true
derivedFromObjectRef:
type: string
xml:
attribute: true
derivedFromVersionRef_BasicModificationDetailsGroup:
type: string
xml:
name: derivedFromVersionRef
attribute: true
description:
$ref: '#/components/schemas/MultilingualString'
xml:
name: Description
extensions:
$ref: '#/components/schemas/ExtensionsStructure'
xml:
name: Extensions
id:
type: string
xml:
attribute: true
infoLinks:
$ref: '#/components/schemas/InfoLinks'
keyList:
$ref: '#/components/schemas/KeyListStructure'
members:
$ref: '#/components/schemas/PointRefs_RelStructure'
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
multiSurface:
$ref: '#/components/schemas/MultiSurfaceType'
xml:
name: MultiSurface
namespace: http://www.opengis.net/gml/3.2
name:
$ref: '#/components/schemas/MultilingualString'
xml:
name: Name
nameOfClass:
type: string
xml:
attribute: true
parentZoneRef:
$ref: '#/components/schemas/ZoneRefStructure'
xml:
name: ParentZoneRef
polygon:
$ref: '#/components/schemas/PolygonType'
xml:
name: Polygon
namespace: http://www.opengis.net/gml/3.2
presentation:
$ref: '#/components/schemas/PresentationStructure'
xml:
name: Presentation
printedPresentation:
$ref: '#/components/schemas/PrintPresentationStructure'
xml:
name: PrintedPresentation
privateCode:
$ref: '#/components/schemas/PrivateCodeStructure'
xml:
name: PrivateCode
projections:
$ref: '#/components/schemas/Projections_RelStructure'
publication:
type: string
enum:
- PUBLIC
- RESTRICTED
- PRIVATE
- CONFIDENTIAL
- AUTHORISED
- TEST
xml:
attribute: true
purposeOfGroupingRef:
$ref: '#/components/schemas/PurposeOfGroupingRefStructure'
xml:
name: PurposeOfGroupingRef
responsibilitySetRef:
type: string
xml:
attribute: true
shortName:
$ref: '#/components/schemas/MultilingualString'
xml:
name: ShortName
status_BasicModificationDetailsGroup:
type: string
enum:
- ACTIVE
- INACTIVE
- OTHER
xml:
name: status
attribute: true
types:
$ref: '#/components/schemas/TypeOfZoneRefs_RelStructure'
validBetween:
type: array
items:
$ref: '#/components/schemas/ValidBetween'
xml:
name: ValidBetween
validityConditions:
$ref: '#/components/schemas/ValidityConditions_RelStructure'
version:
type: string
xml:
attribute: true
CodeType:
type: object
properties:
codeSpace:
type: string
xml:
attribute: true
value:
type: string
PrintPresentationStructure:
type: object
properties:
backgroundColour:
type: string
format: byte
xml:
name: BackgroundColour
backgroundColourName:
type: string
xml:
name: BackgroundColourName
colour:
type: string
xml:
name: Colour
colourName:
type: string
xml:
name: ColourName
colourSystem:
type: string
xml:
name: ColourSystem
fontSize:
type: string
enum:
- VERY_SMALL
- SMALL
- MEDIUM
- LARGE
- VERY_LARGE
xml:
name: FontSize
textColour:
type: string
xml:
name: TextColour
textColourName:
type: string
xml:
name: TextColourName
textFont:
type: string
xml:
name: TextFont
textFontName:
type: string
xml:
name: TextFontName
textLanguage:
type: string
xml:
name: TextLanguage
TypeOfZoneRefs_RelStructure:
type: object
properties:
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
typeOfZoneRef:
type: array
items:
$ref: '#/components/schemas/TypeOfZoneRefStructure'
xml:
name: TypeOfZoneRef
ZoneRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfMemberClass:
type: string
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
TransportOrganisationRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
FareZonesInFrame_RelStructure:
type: object
properties:
fareZone:
type: array
items:
$ref: '#/components/schemas/FareZone'
xml:
name: FareZone
id:
type: string
xml:
attribute: true
required:
- fareZone
CodeWithAuthorityType:
type: object
properties:
codeSpace:
type: string
xml:
attribute: true
value:
type: string
BrandingRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
ExtensionsStructure:
type: object
properties:
any:
type: array
items: {}
VersionOfObjectRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
JAXBElementTransportOrganisationRefStructure:
type: object
properties:
globalScope:
type: boolean
name:
type: object
properties:
localPart:
type: string
namespaceURI:
type: string
prefix:
type: string
nil:
type: boolean
typeSubstituted:
type: boolean
value:
$ref: '#/components/schemas/TransportOrganisationRefStructure'
TariffZoneRefs_RelStructure:
type: object
properties:
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
tariffZoneRef:
type: array
items:
$ref: '#/components/schemas/TariffZoneRef'
xml:
name: TariffZoneRef
required:
- tariffZoneRef
JAXBElementPointRefStructure:
type: object
properties:
globalScope:
type: boolean
name:
type: object
properties:
localPart:
type: string
namespaceURI:
type: string
prefix:
type: string
nil:
type: boolean
typeSubstituted:
type: boolean
value:
$ref: '#/components/schemas/PointRefStructure'
InfoLinkStructure:
type: object
properties:
targetPlatform:
type: string
xml:
attribute: true
typeOfInfoLink:
type: array
items:
type: string
enum:
- CONTACT
- RESOURCE
- INFO
- IMAGE
- DOCUMENT
- TIMETABLE_DOCUMENT
- FARE_SHEET
- DATA_LICENCE
- MOBILE_APP_DOWNLOAD
- MOBILE_APP_INSTALL_CHECK
- MAP
- ICON
- OTHER
xml:
attribute: true
value:
type: string
ValidBetween:
type: object
properties:
alternativeTexts: {}
brandingRef:
$ref: '#/components/schemas/BrandingRefStructure'
xml:
name: BrandingRef
changed:
type: string
format: date-time
xml:
attribute: true
compatibleWithVersionFrameVersionRef:
type: string
xml:
attribute: true
conditionedObjectRef:
$ref: '#/components/schemas/VersionOfObjectRefStructure'
xml:
name: ConditionedObjectRef
created:
type: string
format: date-time
xml:
attribute: true
dataSourceRef:
type: string
xml:
attribute: true
derivedFromObjectRef:
type: string
xml:
attribute: true
derivedFromVersionRef_BasicModificationDetailsGroup:
type: string
xml:
name: derivedFromVersionRef
attribute: true
description:
$ref: '#/components/schemas/MultilingualString'
xml:
name: Description
extensions:
$ref: '#/components/schemas/ExtensionsStructure'
xml:
name: Extensions
fromDate:
type: string
format: date-time
xml:
name: FromDate
id:
type: string
xml:
attribute: true
keyList:
$ref: '#/components/schemas/KeyListStructure'
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
name:
$ref: '#/components/schemas/MultilingualString'
xml:
name: Name
nameOfClass:
type: string
xml:
attribute: true
publication:
type: string
enum:
- PUBLIC
- RESTRICTED
- PRIVATE
- CONFIDENTIAL
- AUTHORISED
- TEST
xml:
attribute: true
responsibilitySetRef:
type: string
xml:
attribute: true
status_BasicModificationDetailsGroup:
type: string
enum:
- ACTIVE
- INACTIVE
- OTHER
xml:
name: status
attribute: true
toDate:
type: string
format: date-time
xml:
name: ToDate
validityConditions:
$ref: '#/components/schemas/ValidityConditions_RelStructure'
version:
type: string
xml:
attribute: true
withConditionRef:
$ref: '#/components/schemas/ValidityConditionRefStructure'
xml:
name: WithConditionRef
xml:
name: ValidBetween
namespace: http://www.netex.org.uk/netex
FareZone:
type: object
properties:
alternativeTexts:
$ref: '#/components/schemas/AlternativeTexts_RelStructure'
brandingRef:
$ref: '#/components/schemas/BrandingRefStructure'
xml:
name: BrandingRef
centroid:
$ref: '#/components/schemas/SimplePoint_VersionStructure'
xml:
name: Centroid
changed:
type: string
format: date-time
xml:
attribute: true
compatibleWithVersionFrameVersionRef:
type: string
xml:
attribute: true
contains:
$ref: '#/components/schemas/TariffZoneRefs_RelStructure'
created:
type: string
format: date-time
xml:
attribute: true
dataSourceRef:
type: string
xml:
attribute: true
derivedFromObjectRef:
type: string
xml:
attribute: true
derivedFromVersionRef_BasicModificationDetailsGroup:
type: string
xml:
name: derivedFromVersionRef
attribute: true
description:
$ref: '#/components/schemas/MultilingualString'
xml:
name: Description
extensions:
$ref: '#/components/schemas/ExtensionsStructure'
xml:
name: Extensions
fareSections:
$ref: '#/components/schemas/FareSections_RelStructure'
groupOfOperatorsRef:
$ref: '#/components/schemas/GroupOfOperatorsRefStructure'
xml:
name: GroupOfOperatorsRef
id:
type: string
xml:
attribute: true
infoLinks:
$ref: '#/components/schemas/InfoLinks'
keyList:
$ref: '#/components/schemas/KeyListStructure'
members:
$ref: '#/components/schemas/PointRefs_RelStructure'
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
multiSurface:
$ref: '#/components/schemas/MultiSurfaceType'
xml:
name: MultiSurface
namespace: http://www.opengis.net/gml/3.2
name:
$ref: '#/components/schemas/MultilingualString'
xml:
name: Name
nameOfClass:
type: string
xml:
attribute: true
neighbours:
$ref: '#/components/schemas/FareZoneRefs_RelStructure'
parentFareZoneRef:
$ref: '#/components/schemas/FareZoneRefStructure'
xml:
name: ParentFareZoneRef
parentZoneRef:
$ref: '#/components/schemas/ZoneRefStructure'
xml:
name: ParentZoneRef
polygon:
$ref: '#/components/schemas/PolygonType'
xml:
name: Polygon
namespace: http://www.opengis.net/gml/3.2
presentation:
$ref: '#/components/schemas/PresentationStructure'
xml:
name: Presentation
printedPresentation:
$ref: '#/components/schemas/PrintPresentationStructure'
xml:
name: PrintedPresentation
privateCode:
$ref: '#/components/schemas/PrivateCodeStructure'
xml:
name: PrivateCode
projections:
$ref: '#/components/schemas/Projections_RelStructure'
publication:
type: string
enum:
- PUBLIC
- RESTRICTED
- PRIVATE
- CONFIDENTIAL
- AUTHORISED
- TEST
xml:
attribute: true
purposeOfGroupingRef:
$ref: '#/components/schemas/PurposeOfGroupingRefStructure'
xml:
name: PurposeOfGroupingRef
responsibilitySetRef:
type: string
xml:
attribute: true
scopingMethod:
type: string
default: explicitStops
enum:
- EXPLICIT_STOPS
- IMPLICIT_SPATIAL_PROJECTION
- EXPLICIT_PERIPHERY_STOPS
- OTHER
xml:
name: ScopingMethod
shortName:
$ref: '#/components/schemas/MultilingualString'
xml:
name: ShortName
status_BasicModificationDetailsGroup:
type: string
enum:
- ACTIVE
- INACTIVE
- OTHER
xml:
name: status
attribute: true
transportOrganisationRef:
$ref: '#/components/schemas/JAXBElementTransportOrganisationRefStructure'
types:
$ref: '#/components/schemas/TypeOfZoneRefs_RelStructure'
validBetween:
type: array
items:
$ref: '#/components/schemas/ValidBetween'
xml:
name: ValidBetween
validityConditions:
$ref: '#/components/schemas/ValidityConditions_RelStructure'
version:
type: string
xml:
attribute: true
zoneTopology:
type: string
enum:
- OVERLAPPING
- HONEYCOMB
- RING
- ANNULAR
- NESTED
- TILED
- SEQUENCE
- OVERLAPPING_SEQUENCE
- OTHER
xml:
name: ZoneTopology
AlternativeTexts_RelStructure:
type: object
properties:
alternativeText:
type: array
items:
$ref: '#/components/schemas/AlternativeText'
xml:
name: AlternativeText
id:
type: string
xml:
attribute: true
required:
- alternativeText
InfoLinks:
type: object
properties:
infoLink:
type: array
items:
$ref: '#/components/schemas/InfoLinkStructure'
xml:
name: InfoLink
required:
- infoLink
FareZoneRefStructure:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfMemberClass:
type: string
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
SurfaceArrayPropertyType:
type: object
properties:
abstractSurface:
type: array
items:
$ref: '#/components/schemas/JAXBElementAbstractSurfaceType'
owns:
type: boolean
xml:
attribute: true
JAXBElementObject:
type: object
properties:
globalScope:
type: boolean
name:
type: object
properties:
localPart:
type: string
namespaceURI:
type: string
prefix:
type: string
nil:
type: boolean
typeSubstituted:
type: boolean
value: {}
TariffZoneRef:
type: object
properties:
changed:
type: string
format: date-time
xml:
attribute: true
created:
type: string
format: date-time
xml:
attribute: true
modification:
type: string
enum:
- NEW
- REVISE
- DELETE
- UNCHANGED
- DELTA
xml:
attribute: true
nameOfMemberClass:
type: string
xml:
attribute: true
nameOfRefClass:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
value:
type: string
version:
type: string
xml:
attribute: true
versionRef:
type: string
xml:
attribute: true
PresentationStructure:
type: object
properties:
backgroundColour:
type: string
format: byte
xml:
name: BackgroundColour
backgroundColourName:
type: string
xml:
name: BackgroundColourName
colour:
type: string
format: byte
xml:
name: Colour
colourName:
type: string
xml:
name: ColourName
colourSystem:
type: string
xml:
name: ColourSystem
infoLinks:
$ref: '#/components/schemas/InfoLinks'
textColour:
type: string
format: byte
xml:
name: TextColour
textColourName:
type: string
xml:
name: TextColourName
textFont:
type: string
xml:
name: TextFont
textFontName:
type: string
xml:
name: TextFontName
textLanguage:
type: string
xml:
name: TextLanguage
PointRefs_RelStructure:
type: object
properties:
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
pointRef:
type: array
items:
$ref: '#/components/schemas/JAXBElementPointRefStructure'
KeyListStructure:
type: object
properties:
keyValue:
type: array
items:
$ref: '#/components/schemas/KeyValueStructure'
xml:
name: KeyValue
required:
- keyValue
MultiSurfaceType:
type: object
properties:
aggregationType:
type: string
enum:
- SET
- BAG
- SEQUENCE
- ARRAY
- RECORD
- TABLE
xml:
attribute: true
descriptionReference:
$ref: '#/components/schemas/ReferenceType'
id:
type: string
xml:
namespace: http://www.opengis.net/gml/3.2
attribute: true
identifier:
$ref: '#/components/schemas/CodeWithAuthorityType'
name:
type: array
items:
$ref: '#/components/schemas/CodeType'
srsDimension:
type: integer
xml:
attribute: true
srsName:
type: string
xml:
attribute: true
surfaceMember:
type: array
items:
$ref: '#/components/schemas/SurfacePropertyType'
surfaceMembers:
$ref: '#/components/schemas/SurfaceArrayPropertyType'
PrivateCodeStructure:
type: object
properties:
type:
type: string
xml:
attribute: true
value:
type: string
ReferenceType:
type: object
properties:
nilReason:
type: array
items:
type: string
xml:
attribute: true
owns:
type: boolean
xml:
attribute: true
FareZoneRefs_RelStructure:
type: object
properties:
fareZoneRef:
type: array
items:
$ref: '#/components/schemas/FareZoneRefStructure'
xml:
name: FareZoneRef
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
required:
- fareZoneRef
SurfacePropertyType:
type: object
properties:
abstractSurface:
$ref: '#/components/schemas/JAXBElementAbstractSurfaceType'
nilReason:
type: array
items:
type: string
xml:
attribute: true
owns:
type: boolean
xml:
attribute: 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
x-refined-from:
- entur-stop-place-v1-read-openapi.json
- entur-stop-place-v1-read-openapi.yml