Skip to content

Ban Dataset #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RobertIdeal wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Ban Dataset #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
226 changes: 224 additions & 2 deletions dist/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -3811,7 +3811,8 @@
"fodbosa",
"mois",
"upujp",
"bev"
"bev",
"ban"
]
},
"CountryISO": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -10067,6 +10272,9 @@
},
{
"$ref": "#/components/schemas/BevAddress"
},
{
"$ref": "#/components/schemas/BanAddress"
}
]
},
Expand Down Expand Up @@ -10881,6 +11089,7 @@
"mois",
"upujp",
"bev",
"ban",
"gbrcleanse",
"uspscleanse"
],
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -13042,6 +13261,9 @@
},
{
"$ref": "#/components/schemas/BevAddress"
},
{
"$ref": "#/components/schemas/BanAddress"
}
]
}
Expand Down
Loading
Loading