From 33af7025c7a9a0cb66265295ed94017649ae803f Mon Sep 17 00:00:00 2001 From: Christopher Blanchard Date: Tue, 30 Apr 2024 11:27:48 +0000 Subject: [PATCH] feat(Norway): Add Kartverket dataset --- dist/openapi.json | 435 +++++++++++++++++++++++++++++++++++++++++-- dist/openapi.yaml | 462 +++++++++++++++++++++++++++++++++++++++++++++- openapi.ts | 333 +++++++++++++++++++++++++++++++-- 3 files changed, 1198 insertions(+), 32 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index b9aa8c7..8a5121b 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -2344,7 +2344,8 @@ "catchall": false, "free": false, "role": true, - "disposable": false + "disposable": false, + "suggestions": [] }, "code": 2000, "message": "Success" @@ -3650,7 +3651,7 @@ "Dataset": { "title": "Dataset", "type": "string", - "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `usps` (USA) USPS Zip+4\n - `herewe` (Western Europe) Western Europe Dataset\n - `gnaf` (Australia) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File", + "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `usps` (USA) USPS Zip+4\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `herewe` (Western Europe) Western Europe Dataset\n - `heret` (Taiwan) Taiwan Dataset\n - `heresa` (South America) South America Dataset\n - `hereo` (Oceania) Oceania Dataset\n - `herena` (North America) North America Dataset\n - `herei` (India) India Dataset\n - `heremea` (Middle East and Africa) Middle East and Africa Dataset\n - `herem` (Macau) Macau Dataset\n - `herehk` (Hong Kong) Hong Kong Dataset\n - `hereee` (Eastern Europe) Eastern Europe Dataset\n - `hereap` (Asia Pacific) Asia Pacific Dataset\n - `gnaf` (AUS) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File\n - `kartverket` (NOR) Norway Dataset", "enum": [ "paf", "pafw", @@ -3674,7 +3675,8 @@ "hereee", "hereap", "gnaf", - "kadaster" + "kadaster", + "kartverket" ] }, "CountryISO": { @@ -6860,6 +6862,400 @@ } } }, + "KartverketAddress": { + "required": [ + "id", + "dataset", + "country", + "country_iso", + "country_iso_2", + "line_1", + "line_2", + "language", + "address", + "latitude", + "longitude", + "lokal_id", + "kommunenummer", + "kommunenavn", + "adressetype", + "adressetilleggsnavn", + "adressetilleggsnavn_kilde", + "adressekode", + "adressenavn", + "nummer", + "bokstav", + "gardsnummer", + "bruksnummer", + "festenummer", + "seksjonsnummer", + "undernummer", + "adresse_tekst", + "adresse_tekst_uten_adressetilleggsnavn", + "bruksenhet_id", + "bruksenhetsnummer_tekst", + "offisiell_adresse_tekst", + "offisiell_adresse_tekst_uten_adressetilleggsnavn", + "epsg_kode", + "nord", + "oest", + "postnummer", + "poststed", + "grunnkretsnummer", + "grunnkretsnavn", + "soknenummer", + "soknenavn", + "organisasjonsnummer", + "tettstednummer", + "tettstednavn", + "valgkretsnummer", + "valgkretsnavn", + "oppdateringsdato", + "datauttaksdato", + "adresse_id", + "uuid_adresse", + "uuid_bruksenhet", + "atkomst_id", + "uuid_atkomst", + "atkomst_nord", + "atkomst_oest", + "sommeratkomst_id", + "uuid_sommeratkomst", + "sommeratkomst_nord", + "sommeratkomst_oest", + "vinteratkomst_id", + "uuid_vinteratkomst", + "vinteratkomst_nord", + "vinteratkomst_oest", + "fylke", + "landsdel" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/ID" + }, + "dataset": { + "type": "string", + "enum": [ + "kartverket" + ] + }, + "country_iso": { + "description": " 3 letter country code (ISO 3166-1)\n", + "enum": [ + "NOR", + "SJM" + ] + }, + "country_iso_2": { + "type": "string", + "description": " 2 letter country code (ISO 3166-1)\n", + "enum": [ + "NO", + "SJ" + ] + }, + "country": { + "type": "string", + "description": " Full country names (ISO 3166)\n", + "enum": [ + "Norway", + "Svalbard and Jan Mayen" + ] + }, + "line_1": { + "type": "string", + "description": "First address line.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Lerkevegen 5" + }, + "line_2": { + "type": "string", + "description": "Second address line.\n\nCan be empty string `\"\"` if not present.\n", + "example": "" + }, + "language": { + "enum": [ + "no" + ], + "description": "Language represented by 2 letter ISO Code (639-1)\n" + }, + "address": { + "type": "string", + "description": "Address / House Number uniquely identifying the address along the specified street.\n\nCan be empty string `\"\"` if not present.\n", + "example": "16" + }, + "longitude": { + "$ref": "#/components/schemas/Longitude" + }, + "latitude": { + "$ref": "#/components/schemas/Latitude" + }, + "lokal_id": { + "type": "string", + "description": "Local identifier assigned by the data supplier.\n\nCan be empty string `\"\"` if not present.\n" + }, + "kommunenummer": { + "type": "string", + "description": "Kommune (municipality) number.\n" + }, + "kommunenavn": { + "type": "string", + "description": "Kommune (municipality) name.\n" + }, + "adressetype": { + "type": "string", + "description": "`vegadresse` = street address, `matrikkeladresse` = land registry address\n" + }, + "adressetilleggsnavn": { + "type": "string", + "description": "A local place name used in a road address.\n\nCan be empty string `\"\"` if not present.\n" + }, + "adressetilleggsnavn_kilde": { + "type": "string", + "description": "Code for adressetilleggsnavn origin.\n\nCan be empty string `\"\"` if not present.\n" + }, + "adressekode": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "A number that uniquely identifies addressable streets, roads, paths, places and areas that are entered in the land register.\n" + } + ] + }, + "adressenavn": { + "type": "string", + "description": "Name of street, road, path, place or area entered in the land register.\n\nCan be empty string `\"\"` if not present.\n" + }, + "nummer": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "A number that uniquely identifies properties, facilities, buildings or entrances to buildings within an addressable street, road, path, place or area.\n" + } + ] + }, + "bokstav": { + "type": "string", + "description": "A subsequent letter that may be used in addition to a number.\n\nCan be empty string `\"\"` if not present.\n" + }, + "gardsnummer": { + "type": "number", + "description": "The number of a farm unit in the land register, unique within each municipality.\n" + }, + "bruksnummer": { + "type": "number", + "description": "A unique identification number automatically assigned to each individual unit within a farm.\n" + }, + "festenummer": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "The number of a fixture within a gardsnummer/bruksnummer.\n" + } + ] + }, + "seksjonsnummer": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "The number of a section within a gardsnummer/bruksnummer and possibly a festenummer.\n" + } + ] + }, + "undernummer": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "A sub-number within a gardsnummer, bruksnummer and festenummer.\n" + } + ] + }, + "adresse_tekst": { + "type": "string", + "description": "Official address text without bruksenhetsnummer, unique within a kommune.\n\nCan be empty string `\"\"` if not present.\n" + }, + "adresse_tekst_uten_adressetilleggsnavn": { + "type": "string", + "description": "Official address text without bruksenhetsnummer and adressetilleggsnavn, unique within a kommune.\n\nCan be empty string `\"\"` if not present.\n" + }, + "bruksenhet_id": { + "type": "string", + "description": "Local identifier for a unit within a building.\n\nCan be empty string `\"\"` if not present.\n" + }, + "bruksenhetsnummer_tekst": { + "type": "string", + "description": "Unit number, e.g. an apartment in a multi-dwelling building.\n\nCan be empty string `\"\"` if not present.\n" + }, + "offisiell_adresse_tekst": { + "type": "string", + "description": "Official address text with bruksenhetsnummer, unique within a kommune.\n\nCan be empty string `\"\"` if not present.\n" + }, + "offisiell_adresse_tekst_uten_adressetilleggsnavn": { + "type": "string", + "description": "Official address text with bruksenhetsnummer and without adressetilleggsnavn, unique within a kommune.\n\nCan be empty string `\"\"` if not present.\n" + }, + "epsg_kode": { + "type": "number", + "description": "EPSG code = `25833`.\n" + }, + "nord": { + "type": "string", + "description": "Northward coordinate of address.\n" + }, + "oest": { + "type": "string", + "description": "Eastward coordinate of address.\n" + }, + "postnummer": { + "type": "string", + "description": "Postal code.\n" + }, + "poststed": { + "type": "string", + "description": "Name of postal town according to Posten.\n" + }, + "grunnkretsnummer": { + "type": "string", + "description": "Identifier consisting of 8 digits, where the first four are the kommunenummer, the next two are the delområdenummer and the last two indicate the grunnkrets.\n\nCan be empty string `\"\"` if not present.\n" + }, + "grunnkretsnavn": { + "type": "string", + "description": "Official grunnkrets name from Statistics Norway (SSB).\n\nCan be empty string `\"\"` if not present.\n" + }, + "soknenummer": { + "type": "string", + "description": "Unique 8 digit identifier of a parish.\n\nCan be empty string `\"\"` if not present.\n" + }, + "soknenavn": { + "type": "string", + "description": "Parish name.\n\nCan be empty string `\"\"` if not present.\n" + }, + "organisasjonsnummer": { + "type": "string", + "description": "Unique identifier of organisation in the Brønnøysund Register.\n\nCan be empty string `\"\"` if not present.\n" + }, + "tettstednummer": { + "type": "string", + "description": "4 digit code for tettsted (urban settlement).\n\nCan be empty string `\"\"` if not present.\n" + }, + "tettstednavn": { + "type": "string", + "description": "Name of tettsted (urban settlement).\n\nCan be empty string `\"\"` if not present.\n" + }, + "valgkretsnummer": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "Constituency code within a kommune.\n" + } + ] + }, + "valgkretsnavn": { + "type": "string", + "description": "Name of constituency.\n\nCan be empty string `\"\"` if not present.\n" + }, + "oppdateringsdato": { + "type": "string", + "description": "Date of last change to the object data.\n" + }, + "datauttaksdato": { + "type": "string", + "description": "Date of extraction from database.\n" + }, + "adresse_id": { + "type": "string", + "description": "Address local identifier assigned by the data supplier.\n" + }, + "uuid_adresse": { + "type": "string", + "description": "Address identifier realized as UUID managed by the cadastral system.\n" + }, + "uuid_bruksenhet": { + "type": "string", + "description": "Unit of usage identifier realized as UUID managed by the cadastral system.\n\nCan be empty string `\"\"` if not present.\n" + }, + "atkomst_id": { + "type": "string", + "description": "Local identifier for means of access to a property.\n\nCan be empty string `\"\"` if not present.\n" + }, + "uuid_atkomst": { + "type": "string", + "description": "Identifier of the means of access to a property realized as UUID in the cadastral system.\n\nCan be empty string `\"\"` if not present.\n" + }, + "atkomst_nord": { + "type": "string", + "description": "Northward coordinate of the means of access to a property.\n\nCan be empty string `\"\"` if not present.\n" + }, + "atkomst_oest": { + "type": "string", + "description": "Eastward coordinate of the means of access to a property.\n\nCan be empty string `\"\"` if not present.\n" + }, + "sommeratkomst_id": { + "type": "string", + "description": "Local identifier for means of access to a property in summer.\n\nCan be empty string `\"\"` if not present.\n" + }, + "uuid_sommeratkomst": { + "type": "string", + "description": "Identifier of the means of access to a property in summer realized as UUID in the cadastral system.\n\nCan be empty string `\"\"` if not present.\n" + }, + "sommeratkomst_nord": { + "type": "string", + "description": "Northward coordinate of the means of access to a property in summer.\n\nCan be empty string `\"\"` if not present.\n" + }, + "sommeratkomst_oest": { + "type": "string", + "description": "Eastward coordinate of the means of access to a property in summer.\n\nCan be empty string `\"\"` if not present.\n" + }, + "vinteratkomst_id": { + "type": "string", + "description": "Local identifier for means of access to a property in winter.\n\nCan be empty string `\"\"` if not present.\n" + }, + "uuid_vinteratkomst": { + "type": "string", + "description": "Identifier of the means of access to a property in winter realized as UUID in the cadastral system.\n\nCan be empty string `\"\"` if not present.\n" + }, + "vinteratkomst_nord": { + "type": "string", + "description": "Northward coordinate of the means of access to a property in winter.\n\nCan be empty string `\"\"` if not present.\n" + }, + "vinteratkomst_oest": { + "type": "string", + "description": "Eastward coordinate of the means of access to a property in winter.\n\nCan be empty string `\"\"` if not present.\n" + }, + "fylke": { + "type": "string", + "description": "Name of county.\n" + }, + "landsdel": { + "type": "string", + "description": "Name of region.\n" + } + } + }, "GbrGlobalAddress": { "title": "Global Address", "description": "Global (non-UK) address in the UK address format", @@ -6991,6 +7387,9 @@ }, { "$ref": "#/components/schemas/KadasterAddress" + }, + { + "$ref": "#/components/schemas/KartverketAddress" } ] }, @@ -7763,7 +8162,8 @@ "email", "phone", "gnaf", - "kadaster" + "kadaster", + "kartverket" ], "properties": { "paf": { @@ -7808,17 +8208,17 @@ }, "ecad": { "type": "boolean", - "description": "IE Address File. Eircode Address Database", + "description": "Republic of Ireland: Eircode Address Database", "example": false }, "ecaf": { "type": "boolean", - "description": "IE Base Address File. Eircode Address File", + "description": "Republic of Ireland: Eircode Address File", "example": false }, "gnaf": { "type": "boolean", - "description": "Australia Geocoded National Address File", + "description": "Australia: Geocoded National Address File", "example": true }, "hereap": { @@ -7893,7 +8293,11 @@ }, "kadaster": { "type": "boolean", - "description": "Kadaster BAG 2.0 Address File", + "description": "Netherlands: Kadaster BAG 2.0 Address File" + }, + "kartverket": { + "type": "boolean", + "description": "Norway: Karverket Address File", "example": true } } @@ -8201,12 +8605,17 @@ }, "gnaf": { "type": "boolean", - "description": "Australia Geoscape Geocoded National Address File", + "description": "Australia: Geoscape Geocoded National Address File", "example": true }, "kadaster": { "type": "boolean", - "description": "Kadaster BAG 2.0 Address File", + "description": "Netherlands: Kadaster BAG 2.0 Address File", + "example": true + }, + "kartverket": { + "type": "boolean", + "description": "Norway: Kartverket Address File", "example": true } } @@ -9414,6 +9823,9 @@ }, { "$ref": "#/components/schemas/KadasterAddress" + }, + { + "$ref": "#/components/schemas/KartverketAddress" } ] } @@ -10575,7 +10987,8 @@ "catchall": false, "free": false, "role": true, - "disposable": false + "disposable": false, + "suggestions": [] }, "code": 2000, "message": "Success" diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 69f35ec..f8b049b 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -1969,6 +1969,7 @@ paths: free: false role: true disposable: false + suggestions: [] code: 2000 message: Success '400': @@ -3048,6 +3049,7 @@ components: Indicates the provenance of an address. - `paf` (GBR) Postcode Address File + - `usps` (USA) USPS Zip+4 - `mr` (GBR) Multiple Residence File - `nyb` (GBR) Not Yet Built File - `pafa` (GBR) Alias File @@ -3055,10 +3057,20 @@ components: - `ab` (GBR) AddressBase Core - `ecaf` (IRL) Eircode ECAF - `ecad` (IRL) Eircode ECAD - - `usps` (USA) USPS Zip+4 - `herewe` (Western Europe) Western Europe Dataset - - `gnaf` (Australia) Geoscape Geocoded National Address File + - `heret` (Taiwan) Taiwan Dataset + - `heresa` (South America) South America Dataset + - `hereo` (Oceania) Oceania Dataset + - `herena` (North America) North America Dataset + - `herei` (India) India Dataset + - `heremea` (Middle East and Africa) Middle East and Africa Dataset + - `herem` (Macau) Macau Dataset + - `herehk` (Hong Kong) Hong Kong Dataset + - `hereee` (Eastern Europe) Eastern Europe Dataset + - `hereap` (Asia Pacific) Asia Pacific Dataset + - `gnaf` (AUS) Geoscape Geocoded National Address File - `kadaster` (NLD) Kadaster BAG 2.0 Address File + - `kartverket` (NOR) Norway Dataset enum: - paf - pafw @@ -3083,6 +3095,7 @@ components: - hereap - gnaf - kadaster + - kartverket CountryISO: title: ISO Country Code (3) type: string @@ -6068,6 +6081,428 @@ components: type: string description: | The province name. + KartverketAddress: + required: + - id + - dataset + - country + - country_iso + - country_iso_2 + - line_1 + - line_2 + - language + - address + - latitude + - longitude + - lokal_id + - kommunenummer + - kommunenavn + - adressetype + - adressetilleggsnavn + - adressetilleggsnavn_kilde + - adressekode + - adressenavn + - nummer + - bokstav + - gardsnummer + - bruksnummer + - festenummer + - seksjonsnummer + - undernummer + - adresse_tekst + - adresse_tekst_uten_adressetilleggsnavn + - bruksenhet_id + - bruksenhetsnummer_tekst + - offisiell_adresse_tekst + - offisiell_adresse_tekst_uten_adressetilleggsnavn + - epsg_kode + - nord + - oest + - postnummer + - poststed + - grunnkretsnummer + - grunnkretsnavn + - soknenummer + - soknenavn + - organisasjonsnummer + - tettstednummer + - tettstednavn + - valgkretsnummer + - valgkretsnavn + - oppdateringsdato + - datauttaksdato + - adresse_id + - uuid_adresse + - uuid_bruksenhet + - atkomst_id + - uuid_atkomst + - atkomst_nord + - atkomst_oest + - sommeratkomst_id + - uuid_sommeratkomst + - sommeratkomst_nord + - sommeratkomst_oest + - vinteratkomst_id + - uuid_vinteratkomst + - vinteratkomst_nord + - vinteratkomst_oest + - fylke + - landsdel + properties: + id: + $ref: '#/components/schemas/ID' + dataset: + type: string + enum: + - kartverket + country_iso: + description: |2 + 3 letter country code (ISO 3166-1) + enum: + - NOR + - SJM + country_iso_2: + type: string + description: |2 + 2 letter country code (ISO 3166-1) + enum: + - 'NO' + - SJ + country: + type: string + description: |2 + Full country names (ISO 3166) + enum: + - Norway + - Svalbard and Jan Mayen + line_1: + type: string + description: | + First address line. + + Can be empty string `""` if not present. + example: Lerkevegen 5 + line_2: + type: string + description: | + Second address line. + + Can be empty string `""` if not present. + example: '' + language: + enum: + - 'no' + description: | + Language represented by 2 letter ISO Code (639-1) + address: + type: string + description: | + Address / House Number uniquely identifying the address along the specified street. + + Can be empty string `""` if not present. + example: '16' + longitude: + $ref: '#/components/schemas/Longitude' + latitude: + $ref: '#/components/schemas/Latitude' + lokal_id: + type: string + description: | + Local identifier assigned by the data supplier. + + Can be empty string `""` if not present. + kommunenummer: + type: string + description: | + Kommune (municipality) number. + kommunenavn: + type: string + description: | + Kommune (municipality) name. + adressetype: + type: string + description: | + `vegadresse` = street address, `matrikkeladresse` = land registry address + adressetilleggsnavn: + type: string + description: | + A local place name used in a road address. + + Can be empty string `""` if not present. + adressetilleggsnavn_kilde: + type: string + description: | + Code for adressetilleggsnavn origin. + + Can be empty string `""` if not present. + adressekode: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + A number that uniquely identifies addressable streets, roads, paths, places and areas that are entered in the land register. + adressenavn: + type: string + description: | + Name of street, road, path, place or area entered in the land register. + + Can be empty string `""` if not present. + nummer: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + A number that uniquely identifies properties, facilities, buildings or entrances to buildings within an addressable street, road, path, place or area. + bokstav: + type: string + description: | + A subsequent letter that may be used in addition to a number. + + Can be empty string `""` if not present. + gardsnummer: + type: number + description: | + The number of a farm unit in the land register, unique within each municipality. + bruksnummer: + type: number + description: | + A unique identification number automatically assigned to each individual unit within a farm. + festenummer: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + The number of a fixture within a gardsnummer/bruksnummer. + seksjonsnummer: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + The number of a section within a gardsnummer/bruksnummer and possibly a festenummer. + undernummer: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + A sub-number within a gardsnummer, bruksnummer and festenummer. + adresse_tekst: + type: string + description: | + Official address text without bruksenhetsnummer, unique within a kommune. + + Can be empty string `""` if not present. + adresse_tekst_uten_adressetilleggsnavn: + type: string + description: | + Official address text without bruksenhetsnummer and adressetilleggsnavn, unique within a kommune. + + Can be empty string `""` if not present. + bruksenhet_id: + type: string + description: | + Local identifier for a unit within a building. + + Can be empty string `""` if not present. + bruksenhetsnummer_tekst: + type: string + description: | + Unit number, e.g. an apartment in a multi-dwelling building. + + Can be empty string `""` if not present. + offisiell_adresse_tekst: + type: string + description: | + Official address text with bruksenhetsnummer, unique within a kommune. + + Can be empty string `""` if not present. + offisiell_adresse_tekst_uten_adressetilleggsnavn: + type: string + description: | + Official address text with bruksenhetsnummer and without adressetilleggsnavn, unique within a kommune. + + Can be empty string `""` if not present. + epsg_kode: + type: number + description: | + EPSG code = `25833`. + nord: + type: string + description: | + Northward coordinate of address. + oest: + type: string + description: | + Eastward coordinate of address. + postnummer: + type: string + description: | + Postal code. + poststed: + type: string + description: | + Name of postal town according to Posten. + grunnkretsnummer: + type: string + description: | + Identifier consisting of 8 digits, where the first four are the kommunenummer, the next two are the delområdenummer and the last two indicate the grunnkrets. + + Can be empty string `""` if not present. + grunnkretsnavn: + type: string + description: | + Official grunnkrets name from Statistics Norway (SSB). + + Can be empty string `""` if not present. + soknenummer: + type: string + description: | + Unique 8 digit identifier of a parish. + + Can be empty string `""` if not present. + soknenavn: + type: string + description: | + Parish name. + + Can be empty string `""` if not present. + organisasjonsnummer: + type: string + description: | + Unique identifier of organisation in the Brønnøysund Register. + + Can be empty string `""` if not present. + tettstednummer: + type: string + description: | + 4 digit code for tettsted (urban settlement). + + Can be empty string `""` if not present. + tettstednavn: + type: string + description: | + Name of tettsted (urban settlement). + + Can be empty string `""` if not present. + valgkretsnummer: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + Constituency code within a kommune. + valgkretsnavn: + type: string + description: | + Name of constituency. + + Can be empty string `""` if not present. + oppdateringsdato: + type: string + description: | + Date of last change to the object data. + datauttaksdato: + type: string + description: | + Date of extraction from database. + adresse_id: + type: string + description: | + Address local identifier assigned by the data supplier. + uuid_adresse: + type: string + description: | + Address identifier realized as UUID managed by the cadastral system. + uuid_bruksenhet: + type: string + description: | + Unit of usage identifier realized as UUID managed by the cadastral system. + + Can be empty string `""` if not present. + atkomst_id: + type: string + description: | + Local identifier for means of access to a property. + + Can be empty string `""` if not present. + uuid_atkomst: + type: string + description: | + Identifier of the means of access to a property realized as UUID in the cadastral system. + + Can be empty string `""` if not present. + atkomst_nord: + type: string + description: | + Northward coordinate of the means of access to a property. + + Can be empty string `""` if not present. + atkomst_oest: + type: string + description: | + Eastward coordinate of the means of access to a property. + + Can be empty string `""` if not present. + sommeratkomst_id: + type: string + description: | + Local identifier for means of access to a property in summer. + + Can be empty string `""` if not present. + uuid_sommeratkomst: + type: string + description: | + Identifier of the means of access to a property in summer realized as UUID in the cadastral system. + + Can be empty string `""` if not present. + sommeratkomst_nord: + type: string + description: | + Northward coordinate of the means of access to a property in summer. + + Can be empty string `""` if not present. + sommeratkomst_oest: + type: string + description: | + Eastward coordinate of the means of access to a property in summer. + + Can be empty string `""` if not present. + vinteratkomst_id: + type: string + description: | + Local identifier for means of access to a property in winter. + + Can be empty string `""` if not present. + uuid_vinteratkomst: + type: string + description: | + Identifier of the means of access to a property in winter realized as UUID in the cadastral system. + + Can be empty string `""` if not present. + vinteratkomst_nord: + type: string + description: | + Northward coordinate of the means of access to a property in winter. + + Can be empty string `""` if not present. + vinteratkomst_oest: + type: string + description: | + Eastward coordinate of the means of access to a property in winter. + + Can be empty string `""` if not present. + fylke: + type: string + description: | + Name of county. + landsdel: + type: string + description: | + Name of region. GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format @@ -6173,6 +6608,7 @@ components: - $ref: '#/components/schemas/HereAddress' - $ref: '#/components/schemas/GnafAddress' - $ref: '#/components/schemas/KadasterAddress' + - $ref: '#/components/schemas/KartverketAddress' postcode_outward: type: string description: Not available for non-UK addresses @@ -6777,6 +7213,7 @@ components: - phone - gnaf - kadaster + - kartverket properties: paf: type: boolean @@ -6812,15 +7249,15 @@ components: example: true ecad: type: boolean - description: IE Address File. Eircode Address Database + description: 'Republic of Ireland: Eircode Address Database' example: false ecaf: type: boolean - description: IE Base Address File. Eircode Address File + description: 'Republic of Ireland: Eircode Address File' example: false gnaf: type: boolean - description: Australia Geocoded National Address File + description: 'Australia: Geocoded National Address File' example: true hereap: type: boolean @@ -6880,7 +7317,10 @@ components: example: true kadaster: type: boolean - description: Kadaster BAG 2.0 Address File + description: 'Netherlands: Kadaster BAG 2.0 Address File' + kartverket: + type: boolean + description: 'Norway: Karverket Address File' example: true ApiKeyAutomatedTopup: title: API Key Automated Topup @@ -7129,11 +7569,15 @@ components: example: true gnaf: type: boolean - description: Australia Geoscape Geocoded National Address File + description: 'Australia: Geoscape Geocoded National Address File' example: true kadaster: type: boolean - description: Kadaster BAG 2.0 Address File + description: 'Netherlands: Kadaster BAG 2.0 Address File' + example: true + kartverket: + type: boolean + description: 'Norway: Kartverket Address File' example: true KeyUsageResult: title: Key Usage @@ -8043,6 +8487,7 @@ components: - $ref: '#/components/schemas/HereAddress' - $ref: '#/components/schemas/GnafAddress' - $ref: '#/components/schemas/KadasterAddress' + - $ref: '#/components/schemas/KartverketAddress' UsaResolveAddressResponse: title: Address Retrieve Response (USA) type: object @@ -8958,6 +9403,7 @@ components: free: false role: true disposable: false + suggestions: [] code: 2000 message: Success required: diff --git a/openapi.ts b/openapi.ts index 71c3b3b..e452852 100644 --- a/openapi.ts +++ b/openapi.ts @@ -1079,6 +1079,7 @@ export interface components { * @description Indicates the provenance of an address. * * - `paf` (GBR) Postcode Address File + * - `usps` (USA) USPS Zip+4 * - `mr` (GBR) Multiple Residence File * - `nyb` (GBR) Not Yet Built File * - `pafa` (GBR) Alias File @@ -1086,10 +1087,20 @@ export interface components { * - `ab` (GBR) AddressBase Core * - `ecaf` (IRL) Eircode ECAF * - `ecad` (IRL) Eircode ECAD - * - `usps` (USA) USPS Zip+4 * - `herewe` (Western Europe) Western Europe Dataset - * - `gnaf` (Australia) Geoscape Geocoded National Address File + * - `heret` (Taiwan) Taiwan Dataset + * - `heresa` (South America) South America Dataset + * - `hereo` (Oceania) Oceania Dataset + * - `herena` (North America) North America Dataset + * - `herei` (India) India Dataset + * - `heremea` (Middle East and Africa) Middle East and Africa Dataset + * - `herem` (Macau) Macau Dataset + * - `herehk` (Hong Kong) Hong Kong Dataset + * - `hereee` (Eastern Europe) Eastern Europe Dataset + * - `hereap` (Asia Pacific) Asia Pacific Dataset + * - `gnaf` (AUS) Geoscape Geocoded National Address File * - `kadaster` (NLD) Kadaster BAG 2.0 Address File + * - `kartverket` (NOR) Norway Dataset * @enum {string} */ Dataset: @@ -1115,7 +1126,8 @@ export interface components { | "hereee" | "hereap" | "gnaf" - | "kadaster"; + | "kadaster" + | "kartverket"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) @@ -3279,6 +3291,291 @@ export interface components { /** @description The province name. */ provincie: string; }; + KartverketAddress: { + id: components["schemas"]["ID"]; + /** @enum {string} */ + dataset: "kartverket"; + /** + * @description 3 letter country code (ISO 3166-1) + * + * @enum {undefined} + */ + country_iso: "NOR" | "SJM"; + /** + * @description 2 letter country code (ISO 3166-1) + * + * @enum {string} + */ + country_iso_2: "NO" | "SJ"; + /** + * @description Full country names (ISO 3166) + * + * @enum {string} + */ + country: "Norway" | "Svalbard and Jan Mayen"; + /** + * @description First address line. + * + * Can be empty string `""` if not present. + * + * @example Lerkevegen 5 + */ + line_1: string; + /** + * @description Second address line. + * + * Can be empty string `""` if not present. + * + * @example + */ + line_2: string; + /** + * @description Language represented by 2 letter ISO Code (639-1) + * + * @enum {undefined} + */ + language: "no"; + /** + * @description Address / House Number uniquely identifying the address along the specified street. + * + * Can be empty string `""` if not present. + * + * @example 16 + */ + address: string; + longitude: components["schemas"]["Longitude"]; + latitude: components["schemas"]["Latitude"]; + /** + * @description Local identifier assigned by the data supplier. + * + * Can be empty string `""` if not present. + */ + lokal_id: string; + /** @description Kommune (municipality) number. */ + kommunenummer: string; + /** @description Kommune (municipality) name. */ + kommunenavn: string; + /** @description `vegadresse` = street address, `matrikkeladresse` = land registry address */ + adressetype: string; + /** + * @description A local place name used in a road address. + * + * Can be empty string `""` if not present. + */ + adressetilleggsnavn: string; + /** + * @description Code for adressetilleggsnavn origin. + * + * Can be empty string `""` if not present. + */ + adressetilleggsnavn_kilde: string; + adressekode: string | number; + /** + * @description Name of street, road, path, place or area entered in the land register. + * + * Can be empty string `""` if not present. + */ + adressenavn: string; + nummer: string | number; + /** + * @description A subsequent letter that may be used in addition to a number. + * + * Can be empty string `""` if not present. + */ + bokstav: string; + /** @description The number of a farm unit in the land register, unique within each municipality. */ + gardsnummer: number; + /** @description A unique identification number automatically assigned to each individual unit within a farm. */ + bruksnummer: number; + festenummer: string | number; + seksjonsnummer: string | number; + undernummer: string | number; + /** + * @description Official address text without bruksenhetsnummer, unique within a kommune. + * + * Can be empty string `""` if not present. + */ + adresse_tekst: string; + /** + * @description Official address text without bruksenhetsnummer and adressetilleggsnavn, unique within a kommune. + * + * Can be empty string `""` if not present. + */ + adresse_tekst_uten_adressetilleggsnavn: string; + /** + * @description Local identifier for a unit within a building. + * + * Can be empty string `""` if not present. + */ + bruksenhet_id: string; + /** + * @description Unit number, e.g. an apartment in a multi-dwelling building. + * + * Can be empty string `""` if not present. + */ + bruksenhetsnummer_tekst: string; + /** + * @description Official address text with bruksenhetsnummer, unique within a kommune. + * + * Can be empty string `""` if not present. + */ + offisiell_adresse_tekst: string; + /** + * @description Official address text with bruksenhetsnummer and without adressetilleggsnavn, unique within a kommune. + * + * Can be empty string `""` if not present. + */ + offisiell_adresse_tekst_uten_adressetilleggsnavn: string; + /** @description EPSG code = `25833`. */ + epsg_kode: number; + /** @description Northward coordinate of address. */ + nord: string; + /** @description Eastward coordinate of address. */ + oest: string; + /** @description Postal code. */ + postnummer: string; + /** @description Name of postal town according to Posten. */ + poststed: string; + /** + * @description Identifier consisting of 8 digits, where the first four are the kommunenummer, the next two are the delområdenummer and the last two indicate the grunnkrets. + * + * Can be empty string `""` if not present. + */ + grunnkretsnummer: string; + /** + * @description Official grunnkrets name from Statistics Norway (SSB). + * + * Can be empty string `""` if not present. + */ + grunnkretsnavn: string; + /** + * @description Unique 8 digit identifier of a parish. + * + * Can be empty string `""` if not present. + */ + soknenummer: string; + /** + * @description Parish name. + * + * Can be empty string `""` if not present. + */ + soknenavn: string; + /** + * @description Unique identifier of organisation in the Brønnøysund Register. + * + * Can be empty string `""` if not present. + */ + organisasjonsnummer: string; + /** + * @description 4 digit code for tettsted (urban settlement). + * + * Can be empty string `""` if not present. + */ + tettstednummer: string; + /** + * @description Name of tettsted (urban settlement). + * + * Can be empty string `""` if not present. + */ + tettstednavn: string; + valgkretsnummer: string | number; + /** + * @description Name of constituency. + * + * Can be empty string `""` if not present. + */ + valgkretsnavn: string; + /** @description Date of last change to the object data. */ + oppdateringsdato: string; + /** @description Date of extraction from database. */ + datauttaksdato: string; + /** @description Address local identifier assigned by the data supplier. */ + adresse_id: string; + /** @description Address identifier realized as UUID managed by the cadastral system. */ + uuid_adresse: string; + /** + * @description Unit of usage identifier realized as UUID managed by the cadastral system. + * + * Can be empty string `""` if not present. + */ + uuid_bruksenhet: string; + /** + * @description Local identifier for means of access to a property. + * + * Can be empty string `""` if not present. + */ + atkomst_id: string; + /** + * @description Identifier of the means of access to a property realized as UUID in the cadastral system. + * + * Can be empty string `""` if not present. + */ + uuid_atkomst: string; + /** + * @description Northward coordinate of the means of access to a property. + * + * Can be empty string `""` if not present. + */ + atkomst_nord: string; + /** + * @description Eastward coordinate of the means of access to a property. + * + * Can be empty string `""` if not present. + */ + atkomst_oest: string; + /** + * @description Local identifier for means of access to a property in summer. + * + * Can be empty string `""` if not present. + */ + sommeratkomst_id: string; + /** + * @description Identifier of the means of access to a property in summer realized as UUID in the cadastral system. + * + * Can be empty string `""` if not present. + */ + uuid_sommeratkomst: string; + /** + * @description Northward coordinate of the means of access to a property in summer. + * + * Can be empty string `""` if not present. + */ + sommeratkomst_nord: string; + /** + * @description Eastward coordinate of the means of access to a property in summer. + * + * Can be empty string `""` if not present. + */ + sommeratkomst_oest: string; + /** + * @description Local identifier for means of access to a property in winter. + * + * Can be empty string `""` if not present. + */ + vinteratkomst_id: string; + /** + * @description Identifier of the means of access to a property in winter realized as UUID in the cadastral system. + * + * Can be empty string `""` if not present. + */ + uuid_vinteratkomst: string; + /** + * @description Northward coordinate of the means of access to a property in winter. + * + * Can be empty string `""` if not present. + */ + vinteratkomst_nord: string; + /** + * @description Eastward coordinate of the means of access to a property in winter. + * + * Can be empty string `""` if not present. + */ + vinteratkomst_oest: string; + /** @description Name of county. */ + fylke: string; + /** @description Name of region. */ + landsdel: string; + }; /** * Global Address * @description Global (non-UK) address in the UK address format @@ -3339,7 +3636,8 @@ export interface components { | components["schemas"]["UspsAddress"] | components["schemas"]["HereAddress"] | components["schemas"]["GnafAddress"] - | components["schemas"]["KadasterAddress"]; + | components["schemas"]["KadasterAddress"] + | components["schemas"]["KartverketAddress"]; /** * @description Not available for non-UK addresses * @enum {string} @@ -3873,17 +4171,17 @@ export interface components { */ usps: boolean; /** - * @description IE Address File. Eircode Address Database + * @description Republic of Ireland: Eircode Address Database * @example false */ ecad: boolean; /** - * @description IE Base Address File. Eircode Address File + * @description Republic of Ireland: Eircode Address File * @example false */ ecaf: boolean; /** - * @description Australia Geocoded National Address File + * @description Australia: Geocoded National Address File * @example true */ gnaf: boolean; @@ -3957,11 +4255,13 @@ export interface components { * @example true */ email: boolean; + /** @description Netherlands: Kadaster BAG 2.0 Address File */ + kadaster: boolean; /** - * @description Kadaster BAG 2.0 Address File + * @description Norway: Karverket Address File * @example true */ - kadaster: boolean; + kartverket: boolean; }; /** * API Key Automated Topup @@ -4168,15 +4468,20 @@ export interface components { */ email?: boolean; /** - * @description Australia Geoscape Geocoded National Address File + * @description Australia: Geoscape Geocoded National Address File * @example true */ gnaf?: boolean; /** - * @description Kadaster BAG 2.0 Address File + * @description Netherlands: Kadaster BAG 2.0 Address File * @example true */ kadaster?: boolean; + /** + * @description Norway: Kartverket Address File + * @example true + */ + kartverket?: boolean; }; }; /** Key Usage */ @@ -4728,7 +5033,8 @@ export interface components { | components["schemas"]["AbAddress"] | components["schemas"]["HereAddress"] | components["schemas"]["GnafAddress"] - | components["schemas"]["KadasterAddress"]; + | components["schemas"]["KadasterAddress"] + | components["schemas"]["KartverketAddress"]; }; /** Address Retrieve Response (USA) */ UsaResolveAddressResponse: { @@ -5447,7 +5753,8 @@ export interface components { * "catchall": false, * "free": false, * "role": true, - * "disposable": false + * "disposable": false, + * "suggestions": [] * }, * "code": 2000, * "message": "Success"