openapi: 3.2.0
info:
title: Entur Geographic Areas API
version: 2026.05.0
contact:
name: Entur API Support
url: https://developer.entur.org
description: 'Operations tagged Geographic Areas 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: Geographic Areas
description: Query topographic places (municipalities, counties, countries) and tariff zones for geographic and administrative boundaries.
paths:
/topographic-places:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Geographic Areas
summary: List topographic places
description: Retrieves a paginated list of topographic places representing administrative and geographic areas such as municipalities, counties, and countries. Supports both JSON (default) and XML formats via Accept header.
operationId: getTopographicPlaces
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 topographic place IDs
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Successfully retrieved list of topographic places
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TopographicPlace'
examples:
Topographic Places List:
summary: Example list of topographic places
description: Topographic Places List
value:
- id: KVE:TopographicPlace:03
version: '1'
descriptor:
name:
value: Oslo
lang: nor
isoCode: NO-03
countryRef:
ref: 'NO'
application/xml:
schema:
$ref: '#/components/schemas/TopographicPlacesInFrame_RelStructure'
examples:
Topographic Places XML:
summary: Example list in NeTEx XML format
description: Topographic Places XML
value: "\n\n \n \n Oslo\n \n NO-03\n \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/TopographicPlace'
servers:
- url: https://api.entur.io/stop-places/v1/read
/topographic-places/{id}:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Geographic Areas
summary: Get topographic place by ID
description: Retrieves detailed information about a specific topographic place including name, type, boundaries, and hierarchical relationships. Supports both JSON (default) and XML formats via Accept header.
operationId: getTopographicPlaceById
parameters:
- name: id
in: path
description: Unique identifier for the topographic place
required: true
style: simple
explode: false
schema:
type: string
example: KVE:TopographicPlace:03
responses:
'200':
description: Successfully retrieved topographic place
content:
application/json:
schema:
$ref: '#/components/schemas/TopographicPlace'
examples:
Topographic Place:
summary: Example topographic place (Oslo county)
description: Topographic Place
value:
id: KVE:TopographicPlace:03
version: '1'
descriptor:
name:
value: Oslo
lang: nor
isoCode: NO-03
topographicPlaceType: COUNTY
countryRef:
ref: 'NO'
application/xml:
schema:
$ref: '#/components/schemas/TopographicPlace'
examples:
Topographic Place XML:
summary: Example in NeTEx XML format
description: Topographic Place XML
value: "\n\n \n Oslo\n \n NO-03\n county\n \n\n"
'404':
description: Topographic place not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/TopographicPlace'
servers:
- url: https://api.entur.io/stop-places/v1/read
/topographic-places/{id}/versions:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Geographic Areas
summary: List topographic place versions
description: Retrieves all historical versions of a specific topographic place. Tracks changes to boundaries, names, or administrative classifications. Supports both JSON (default) and XML formats via Accept header.
operationId: getTopographicPlaceVersions
parameters:
- name: id
in: path
description: Unique identifier for the topographic place
required: true
style: simple
explode: false
schema:
type: string
example: KVE:TopographicPlace:03
responses:
'200':
description: Successfully retrieved topographic place versions
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TopographicPlace'
examples:
Topographic Place Versions:
summary: Example list of topographic place versions
description: Topographic Place Versions
value:
- id: KVE:TopographicPlace:03
version: '2'
name:
value: Oslo
lang: nor
topographicPlaceType: COUNTY
- id: KVE:TopographicPlace:03
version: '1'
name:
value: Oslo
lang: nor
topographicPlaceType: COUNTY
application/xml:
schema:
$ref: '#/components/schemas/TopographicPlacesInFrame_RelStructure'
examples:
Topographic Place Versions XML:
summary: Example list of topographic place versions in NeTEx XML format
description: Topographic Place Versions XML
value: "\n\n \n Oslo\n county\n \n \n Oslo\n county\n \n\n"
'404':
description: Topographic place 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/TopographicPlace'
servers:
- url: https://api.entur.io/stop-places/v1/read
/topographic-places/{id}/versions/{version}:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Geographic Areas
summary: Get specific topographic place version
description: Retrieves a specific historical version of a topographic place by ID and version number. Supports both JSON (default) and XML formats via Accept header.
operationId: getTopographicPlaceVersion
parameters:
- name: id
in: path
description: Unique identifier for the topographic place
required: true
style: simple
explode: false
schema:
type: string
example: KVE:TopographicPlace:03
- name: version
in: path
description: Version number
required: true
style: simple
explode: false
schema:
type: string
example: 2
responses:
'200':
description: Successfully retrieved topographic place version
content:
application/json:
schema:
$ref: '#/components/schemas/TopographicPlace'
examples:
Topographic Place Version:
summary: Example specific topographic place version
description: Topographic Place Version
value:
id: KVE:TopographicPlace:03
version: '1'
name:
value: Oslo
lang: nor
topographicPlaceType: COUNTY
countryRef:
ref: 'NO'
application/xml:
schema:
$ref: '#/components/schemas/TopographicPlace'
examples:
Topographic Place Version XML:
summary: Example specific topographic place version in NeTEx XML format
description: Topographic Place Version XML
value: "\n\n Oslo\n county\n \n\n"
'404':
description: Topographic place or version not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/TopographicPlace'
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
TopographicPlace:
type: object
properties:
accesses:
$ref: '#/components/schemas/Accesses_RelStructure'
adjacentPlaces:
$ref: '#/components/schemas/TopographicPlaceRefs_RelStructure'
alternativeDescriptors:
$ref: '#/components/schemas/AlternativeDescriptors'
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
containedIn:
$ref: '#/components/schemas/TopographicPlaceRefs_RelStructure'
countryRef:
$ref: '#/components/schemas/CountryRef'
xml:
name: CountryRef
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
descriptor:
$ref: '#/components/schemas/TopographicPlaceDescriptor_VersionedChildStructure'
xml:
name: Descriptor
extensions:
$ref: '#/components/schemas/ExtensionsStructure'
xml:
name: Extensions
id:
type: string
xml:
attribute: true
infoLinks:
$ref: '#/components/schemas/InfoLinks'
isoCode:
type: string
xml:
name: IsoCode
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
otherCountries:
$ref: '#/components/schemas/CountryRefs_RelStructure'
parentTopographicPlaceRef:
$ref: '#/components/schemas/TopographicPlaceRefStructure'
xml:
name: ParentTopographicPlaceRef
parentZoneRef:
$ref: '#/components/schemas/ZoneRefStructure'
xml:
name: ParentZoneRef
placeCentre:
type: boolean
default: false
xml:
name: PlaceCentre
placeTypes:
$ref: '#/components/schemas/TypeOfPlaceRefs_RelStructure'
polygon:
$ref: '#/components/schemas/PolygonType'
xml:
name: Polygon
namespace: http://www.opengis.net/gml/3.2
postCode:
type: string
xml:
name: PostCode
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
topographicPlaceType:
type: string
enum:
- CONTINENT
- INTERREGION
- COUNTRY
- PRINCIPALITY
- STATE
- PROVINCE
- REGION
- COUNTY
- AREA
- CONURBATION
- CITY
- MUNICIPALITY
- QUARTER
- SUBURB
- TOWN
- URBAN_CENTRE
- DISTRICT
- PARISH
- VILLAGE
- HAMLET
- PLACE_OF_INTEREST
- OTHER
- UNRECORDED
xml:
name: TopographicPlaceType
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
required:
- descriptor
CountryRef:
type: object
properties:
ref:
type: string
enum:
- AC
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AN
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AZ
- AX
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BM
- BN
- BO
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CS
- CU
- CV
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- EU
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- ME
- MC
- MD
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- ST
- SV
- SY
- SZ
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TP
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UK
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- YE
- YT
- YU
- ZA
- ZM
- ZW
xml:
attribute: true
refPrincipality:
type: string
xml:
attribute: true
value:
type: string
xml:
name: CountryRef
namespace: http://www.netex.org.uk/netex
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
TypeOfPlaceRefs_RelStructure:
type: object
properties:
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
typeOfPlaceRef:
type: array
items:
$ref: '#/components/schemas/TypeOfPlaceRefStructure'
xml:
name: TypeOfPlaceRef
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
TopographicPlaceDescriptor_VersionedChildStructure:
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
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
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
qualify:
$ref: '#/components/schemas/Qualify'
xml:
name: Qualify
shortName:
$ref: '#/components/schemas/MultilingualString'
xml:
name: ShortName
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
required:
- name
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: {}
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
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'
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
CountryRefs_RelStructure:
type: object
properties:
countryRef:
type: array
items:
$ref: '#/components/schemas/CountryRef'
xml:
name: CountryRef
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
required:
- countryRef
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
TopographicPlaceRefs_RelStructure:
type: object
properties:
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
topographicPlaceRef:
type: array
items:
$ref: '#/components/schemas/TopographicPlaceRefStructure'
xml:
name: TopographicPlaceRef
required:
- topographicPlaceRef
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
CodeType:
type: object
properties:
codeSpace:
type: string
xml:
attribute: true
value:
type: string
Accesses_RelStructure:
type: object
properties:
accessRefOrAccess:
type: array
items: {}
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
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
TopographicPlacesInFrame_RelStructure:
type: object
properties:
id:
type: string
xml:
attribute: true
modificationSet:
type: string
enum:
- ALL
- CHANGES_ONLY
xml:
attribute: true
topographicPlace:
type: array
items:
$ref: '#/components/schemas/TopographicPlace'
xml:
name: TopographicPlace
required:
- topographicPlace
AlternativeDescriptors:
type: object
properties:
id:
type: string
xml:
attribute: true
topographicPlaceDescriptor:
type: array
items:
$ref: '#/components/schemas/TopographicPlaceDescriptor_VersionedChildStructure'
xml:
name: TopographicPlaceDescriptor
required:
- topographicPlaceDescriptor
TopographicPlaceRefStructure:
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
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
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
CodeWithAuthorityType:
type: object
properties:
codeSpace:
type: string
xml:
attribute: true
value:
type: string
ExtensionsStructure:
type: object
properties:
any:
type: array
items: {}
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'
TypeOfPlaceRefStructure:
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
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
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
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: {}
SurfaceArrayPropertyType:
type: object
properties:
abstractSurface:
type: array
items:
$ref: '#/components/schemas/JAXBElementAbstractSurfaceType'
owns:
type: boolean
xml:
attribute: true
Qualify:
type: object
properties:
qualifierName:
$ref: '#/components/schemas/MultilingualString'
xml:
name: QualifierName
topographicPlaceRef:
$ref: '#/components/schemas/TopographicPlaceRefStructure'
xml:
name: TopographicPlaceRef
required:
- qualifierName
KeyListStructure:
type: object
properties:
keyValue:
type: array
items:
$ref: '#/components/schemas/KeyValueStructure'
xml:
name: KeyValue
required:
- keyValue
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'
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
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
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