From efef4ea40f55153b1cc17ce527460d727b89a25a Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Mon, 11 May 2026 11:39:26 +0100 Subject: [PATCH] Ban Dataset --- dist/openapi.json | 226 +++++++++++++++++++++++++++++++++++++++++++++- dist/openapi.yaml | 211 +++++++++++++++++++++++++++++++++++++++++++ openapi.ts | 119 +++++++++++++++++++++++- 3 files changed, 551 insertions(+), 5 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index d4662bf..50bde13 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -3780,7 +3780,7 @@ "Dataset": { "title": "Dataset", "type": "string", - "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\n - `sdfi` (DNK) Denmark Dataset\n - `cannar` (CAN) Canada National Address Register Dataset\n - `fodbosa` (BEL) Belgium Dataset\n - `mois` (KOR) South Korea Dataset\n - `upujp` (JPN) Japan UPU Address File\n - `bev` (AUT) Austria Dataset", + "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\n - `sdfi` (DNK) Denmark Dataset\n - `cannar` (CAN) Canada National Address Register Dataset\n - `fodbosa` (BEL) Belgium Dataset\n - `mois` (KOR) South Korea Dataset\n - `upujp` (JPN) Japan UPU Address File\n - `bev` (AUT) Austria Dataset\n - `ban` (FRA) France BAN Dataset", "enum": [ "paf", "pafw", @@ -3811,7 +3811,8 @@ "fodbosa", "mois", "upujp", - "bev" + "bev", + "ban" ] }, "CountryISO": { @@ -9915,6 +9916,210 @@ } } }, + "BanAddress": { + "required": [ + "id", + "dataset", + "country", + "country_iso", + "country_iso_2", + "language", + "address", + "line_1", + "line_2", + "latitude", + "longitude", + "id_fantoir", + "numero", + "rep", + "nom_voie", + "code_postal", + "code_insee", + "nom_commune", + "code_insee_ancienne_commune", + "nom_ancienne_commune", + "x", + "y", + "lon", + "lat", + "type_position", + "alias", + "nom_ld", + "libelle_acheminement", + "nom_afnor", + "source_position", + "source_nom_voie", + "certification_commune", + "cad_parcelles" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/ID" + }, + "dataset": { + "type": "string", + "enum": [ + "ban" + ] + }, + "country_iso": { + "description": " 3 letter country code (ISO 3166-1)\n", + "enum": [ + "FRA" + ] + }, + "country_iso_2": { + "type": "string", + "description": " 2 letter country code (ISO 3166-1)\n", + "enum": [ + "FR" + ] + }, + "country": { + "type": "string", + "description": " Full country names (ISO 3166)\n", + "enum": [ + "France" + ] + }, + "language": { + "enum": [ + "fr" + ], + "description": "Language represented by 2 letter ISO Code (639-1)\n" + }, + "address": { + "type": "string", + "description": "The house number of the address.\n\nCan be empty string `\"\"` if not present.\n", + "example": "8" + }, + "line_1": { + "type": "string", + "nullable": true, + "description": "First address line (house number, suffix, and street name).\n\nCan be `null` if not present.\n", + "example": "8 bis avenue des Champs-Élysées" + }, + "line_2": { + "type": "string", + "nullable": true, + "description": "Second address line (postcode and municipality name).\n\nCan be `null` if not present.\n", + "example": "75008 Paris" + }, + "longitude": { + "$ref": "#/components/schemas/Longitude" + }, + "latitude": { + "$ref": "#/components/schemas/Latitude" + }, + "id_fantoir": { + "type": "string", + "nullable": true, + "description": "FANTOIR street identifier\n" + }, + "numero": { + "type": "integer", + "nullable": true, + "description": "House number\n" + }, + "rep": { + "type": "string", + "nullable": true, + "description": "House number suffix / répétition (`bis`, `ter`, `quater`, etc.)\n" + }, + "nom_voie": { + "type": "string", + "description": "Street name\n" + }, + "code_postal": { + "type": "string", + "nullable": true, + "description": "5-digit postal code\n" + }, + "code_insee": { + "type": "string", + "description": "INSEE commune code (2-digit département + 3-digit commune)\n" + }, + "nom_commune": { + "type": "string", + "description": "Municipality name\n" + }, + "code_insee_ancienne_commune": { + "type": "string", + "nullable": true, + "description": "INSEE code of the pre-fusion commune (for merged municipalities)\n" + }, + "nom_ancienne_commune": { + "type": "string", + "nullable": true, + "description": "Name of the pre-fusion commune (for merged municipalities)\n" + }, + "x": { + "type": "string", + "nullable": true, + "description": "Lambert 93 easting coordinate\n" + }, + "y": { + "type": "string", + "nullable": true, + "description": "Lambert 93 northing coordinate\n" + }, + "lon": { + "type": "string", + "nullable": true, + "description": "Longitude (WGS84) as returned from source data\n" + }, + "lat": { + "type": "string", + "nullable": true, + "description": "Latitude (WGS84) as returned from source data\n" + }, + "type_position": { + "type": "string", + "nullable": true, + "description": "Positional accuracy type (`entrée`, `bâtiment`, `parcelle`, `délivrance postale`, etc.)\n" + }, + "alias": { + "type": "string", + "nullable": true, + "description": "Address alias\n" + }, + "nom_ld": { + "type": "string", + "nullable": true, + "description": "Lieu-dit (named place) label\n" + }, + "libelle_acheminement": { + "type": "string", + "nullable": true, + "description": "Postal routing label\n" + }, + "nom_afnor": { + "type": "string", + "nullable": true, + "description": "AFNOR-normalised street name\n" + }, + "source_position": { + "type": "string", + "nullable": true, + "description": "Source of position data (`commune`, `IGN`, etc.)\n" + }, + "source_nom_voie": { + "type": "string", + "nullable": true, + "description": "Source of street name data\n" + }, + "certification_commune": { + "type": "boolean", + "nullable": true, + "description": "Whether the municipality has certified this address\n" + }, + "cad_parcelles": { + "type": "string", + "nullable": true, + "description": "Cadastral parcel reference(s)\n" + } + } + }, "GbrGlobalAddress": { "title": "Global Address", "description": "Global (non-UK) address in the UK address format", @@ -10067,6 +10272,9 @@ }, { "$ref": "#/components/schemas/BevAddress" + }, + { + "$ref": "#/components/schemas/BanAddress" } ] }, @@ -10881,6 +11089,7 @@ "mois", "upujp", "bev", + "ban", "gbrcleanse", "uspscleanse" ], @@ -11049,6 +11258,11 @@ "description": "Austria: BEV Address File", "example": true }, + "ban": { + "type": "boolean", + "description": "France: BAN (Base Adresse Nationale)", + "example": true + }, "gbrcleanse": { "type": "boolean", "description": "UK GBR Cleanse", @@ -11460,6 +11674,11 @@ "description": "Austria: BEV Address File", "example": true }, + "ban": { + "type": "boolean", + "description": "France: BAN (Base Adresse Nationale)", + "example": true + }, "ab": { "type": "boolean", "description": "UK AddressBase dataset", @@ -13042,6 +13261,9 @@ }, { "$ref": "#/components/schemas/BevAddress" + }, + { + "$ref": "#/components/schemas/BanAddress" } ] } diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 1ef4586..9a8efd6 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -3141,6 +3141,7 @@ components: - `mois` (KOR) South Korea Dataset - `upujp` (JPN) Japan UPU Address File - `bev` (AUT) Austria Dataset + - `ban` (FRA) France BAN Dataset enum: - paf - pafw @@ -3172,6 +3173,7 @@ components: - mois - upujp - bev + - ban CountryISO: title: ISO Country Code (3) type: string @@ -9563,6 +9565,204 @@ components: type: string description: | Name of the census district + BanAddress: + required: + - id + - dataset + - country + - country_iso + - country_iso_2 + - language + - address + - line_1 + - line_2 + - latitude + - longitude + - id_fantoir + - numero + - rep + - nom_voie + - code_postal + - code_insee + - nom_commune + - code_insee_ancienne_commune + - nom_ancienne_commune + - x + - 'y' + - lon + - lat + - type_position + - alias + - nom_ld + - libelle_acheminement + - nom_afnor + - source_position + - source_nom_voie + - certification_commune + - cad_parcelles + properties: + id: + $ref: '#/components/schemas/ID' + dataset: + type: string + enum: + - ban + country_iso: + description: |2 + 3 letter country code (ISO 3166-1) + enum: + - FRA + country_iso_2: + type: string + description: |2 + 2 letter country code (ISO 3166-1) + enum: + - FR + country: + type: string + description: |2 + Full country names (ISO 3166) + enum: + - France + language: + enum: + - fr + description: | + Language represented by 2 letter ISO Code (639-1) + address: + type: string + description: | + The house number of the address. + + Can be empty string `""` if not present. + example: '8' + line_1: + type: string + nullable: true + description: | + First address line (house number, suffix, and street name). + + Can be `null` if not present. + example: 8 bis avenue des Champs-Élysées + line_2: + type: string + nullable: true + description: | + Second address line (postcode and municipality name). + + Can be `null` if not present. + example: 75008 Paris + longitude: + $ref: '#/components/schemas/Longitude' + latitude: + $ref: '#/components/schemas/Latitude' + id_fantoir: + type: string + nullable: true + description: | + FANTOIR street identifier + numero: + type: integer + nullable: true + description: | + House number + rep: + type: string + nullable: true + description: | + House number suffix / répétition (`bis`, `ter`, `quater`, etc.) + nom_voie: + type: string + description: | + Street name + code_postal: + type: string + nullable: true + description: | + 5-digit postal code + code_insee: + type: string + description: | + INSEE commune code (2-digit département + 3-digit commune) + nom_commune: + type: string + description: | + Municipality name + code_insee_ancienne_commune: + type: string + nullable: true + description: | + INSEE code of the pre-fusion commune (for merged municipalities) + nom_ancienne_commune: + type: string + nullable: true + description: | + Name of the pre-fusion commune (for merged municipalities) + x: + type: string + nullable: true + description: | + Lambert 93 easting coordinate + 'y': + type: string + nullable: true + description: | + Lambert 93 northing coordinate + lon: + type: string + nullable: true + description: | + Longitude (WGS84) as returned from source data + lat: + type: string + nullable: true + description: | + Latitude (WGS84) as returned from source data + type_position: + type: string + nullable: true + description: | + Positional accuracy type (`entrée`, `bâtiment`, `parcelle`, `délivrance postale`, etc.) + alias: + type: string + nullable: true + description: | + Address alias + nom_ld: + type: string + nullable: true + description: | + Lieu-dit (named place) label + libelle_acheminement: + type: string + nullable: true + description: | + Postal routing label + nom_afnor: + type: string + nullable: true + description: | + AFNOR-normalised street name + source_position: + type: string + nullable: true + description: | + Source of position data (`commune`, `IGN`, etc.) + source_nom_voie: + type: string + nullable: true + description: | + Source of street name data + certification_commune: + type: boolean + nullable: true + description: | + Whether the municipality has certified this address + cad_parcelles: + type: string + nullable: true + description: | + Cadastral parcel reference(s) GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format @@ -9675,6 +9875,7 @@ components: - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' - $ref: '#/components/schemas/BevAddress' + - $ref: '#/components/schemas/BanAddress' postcode_outward: type: string description: Not available for non-UK addresses @@ -10320,6 +10521,7 @@ components: - mois - upujp - bev + - ban - gbrcleanse - uspscleanse properties: @@ -10454,6 +10656,10 @@ components: type: boolean description: 'Austria: BEV Address File' example: true + ban: + type: boolean + description: 'France: BAN (Base Adresse Nationale)' + example: true gbrcleanse: type: boolean description: UK GBR Cleanse @@ -10788,6 +10994,10 @@ components: type: boolean description: 'Austria: BEV Address File' example: true + ban: + type: boolean + description: 'France: BAN (Base Adresse Nationale)' + example: true ab: type: boolean description: UK AddressBase dataset @@ -12054,6 +12264,7 @@ components: - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' - $ref: '#/components/schemas/BevAddress' + - $ref: '#/components/schemas/BanAddress' UsaResolveAddressResponse: title: Address Retrieve Response (USA) type: object diff --git a/openapi.ts b/openapi.ts index 2e82f60..dd6fcf1 100644 --- a/openapi.ts +++ b/openapi.ts @@ -1135,6 +1135,7 @@ export interface components { * - `mois` (KOR) South Korea Dataset * - `upujp` (JPN) Japan UPU Address File * - `bev` (AUT) Austria Dataset + * - `ban` (FRA) France BAN Dataset * @enum {string} */ Dataset: @@ -1167,7 +1168,8 @@ export interface components { | "fodbosa" | "mois" | "upujp" - | "bev"; + | "bev" + | "ban"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) @@ -5877,6 +5879,105 @@ export interface components { /** @description Name of the census district */ zaehlsprengelname: string; }; + BanAddress: { + id: components["schemas"]["ID"]; + /** @enum {string} */ + dataset: "ban"; + /** + * @description 3 letter country code (ISO 3166-1) + * + * @enum {undefined} + */ + country_iso: "FRA"; + /** + * @description 2 letter country code (ISO 3166-1) + * + * @enum {string} + */ + country_iso_2: "FR"; + /** + * @description Full country names (ISO 3166) + * + * @enum {string} + */ + country: "France"; + /** + * @description Language represented by 2 letter ISO Code (639-1) + * + * @enum {undefined} + */ + language: "fr"; + /** + * @description The house number of the address. + * + * Can be empty string `""` if not present. + * + * @example 8 + */ + address: string; + /** + * @description First address line (house number, suffix, and street name). + * + * Can be `null` if not present. + * + * @example 8 bis avenue des Champs-Élysées + */ + line_1: string | null; + /** + * @description Second address line (postcode and municipality name). + * + * Can be `null` if not present. + * + * @example 75008 Paris + */ + line_2: string | null; + longitude: components["schemas"]["Longitude"]; + latitude: components["schemas"]["Latitude"]; + /** @description FANTOIR street identifier */ + id_fantoir: string | null; + /** @description House number */ + numero: number | null; + /** @description House number suffix / répétition (`bis`, `ter`, `quater`, etc.) */ + rep: string | null; + /** @description Street name */ + nom_voie: string; + /** @description 5-digit postal code */ + code_postal: string | null; + /** @description INSEE commune code (2-digit département + 3-digit commune) */ + code_insee: string; + /** @description Municipality name */ + nom_commune: string; + /** @description INSEE code of the pre-fusion commune (for merged municipalities) */ + code_insee_ancienne_commune: string | null; + /** @description Name of the pre-fusion commune (for merged municipalities) */ + nom_ancienne_commune: string | null; + /** @description Lambert 93 easting coordinate */ + x: string | null; + /** @description Lambert 93 northing coordinate */ + y: string | null; + /** @description Longitude (WGS84) as returned from source data */ + lon: string | null; + /** @description Latitude (WGS84) as returned from source data */ + lat: string | null; + /** @description Positional accuracy type (`entrée`, `bâtiment`, `parcelle`, `délivrance postale`, etc.) */ + type_position: string | null; + /** @description Address alias */ + alias: string | null; + /** @description Lieu-dit (named place) label */ + nom_ld: string | null; + /** @description Postal routing label */ + libelle_acheminement: string | null; + /** @description AFNOR-normalised street name */ + nom_afnor: string | null; + /** @description Source of position data (`commune`, `IGN`, etc.) */ + source_position: string | null; + /** @description Source of street name data */ + source_nom_voie: string | null; + /** @description Whether the municipality has certified this address */ + certification_commune: boolean | null; + /** @description Cadastral parcel reference(s) */ + cad_parcelles: string | null; + }; /** * Global Address * @description Global (non-UK) address in the UK address format @@ -5944,7 +6045,8 @@ export interface components { | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] | components["schemas"]["UpujpAddress"] - | components["schemas"]["BevAddress"]; + | components["schemas"]["BevAddress"] + | components["schemas"]["BanAddress"]; /** * @description Not available for non-UK addresses * @enum {string} @@ -6625,6 +6727,11 @@ export interface components { * @example true */ bev: boolean; + /** + * @description France: BAN (Base Adresse Nationale) + * @example true + */ + ban: boolean; /** * @description UK GBR Cleanse * @example true @@ -6917,6 +7024,11 @@ export interface components { * @example true */ bev?: boolean; + /** + * @description France: BAN (Base Adresse Nationale) + * @example true + */ + ban?: boolean; /** * @description UK AddressBase dataset * @example false @@ -7886,7 +7998,8 @@ export interface components { | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] | components["schemas"]["UpujpAddress"] - | components["schemas"]["BevAddress"]; + | components["schemas"]["BevAddress"] + | components["schemas"]["BanAddress"]; }; /** Address Retrieve Response (USA) */ UsaResolveAddressResponse: {