Skip to content

Commit 8447a7c

Browse files
cblanccblanc
authored
Merge pull request #221 from ideal-postcodes/cannar
feat(Canada): Add Canadian national address file
2 parents a9f7c86 + b7130cd commit 8447a7c

File tree

3 files changed

+918
-6
lines changed

3 files changed

+918
-6
lines changed

‎dist/openapi.json‎

Lines changed: 286 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3775,7 +3775,7 @@
37753775
"Dataset": {
37763776
"title": "Dataset",
37773777
"type": "string",
3778-
"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",
3778+
"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",
37793779
"enum": [
37803780
"paf",
37813781
"pafw",
@@ -3801,7 +3801,8 @@
38013801
"gnaf",
38023802
"kadaster",
38033803
"kartverket",
3804-
"sdfi"
3804+
"sdfi",
3805+
"cannar"
38053806
]
38063807
},
38073808
"CountryISO": {
@@ -7894,6 +7895,271 @@
78947895
}
78957896
}
78967897
},
7898+
"CannarAddress": {
7899+
"required": [
7900+
"id",
7901+
"dataset",
7902+
"country",
7903+
"country_iso",
7904+
"country_iso_2",
7905+
"language",
7906+
"address",
7907+
"line_1",
7908+
"line_2",
7909+
"latitude",
7910+
"longitude",
7911+
"loc_guid",
7912+
"addr_guid",
7913+
"apt_no_label",
7914+
"civic_no",
7915+
"civic_no_suffix",
7916+
"official_street_name",
7917+
"official_street_type",
7918+
"official_street_dir",
7919+
"prov_code",
7920+
"csd_eng_name",
7921+
"csd_fre_name",
7922+
"csd_type_eng_code",
7923+
"csd_type_fre_code",
7924+
"mail_street_name",
7925+
"mail_street_type",
7926+
"mail_street_dir",
7927+
"mail_mun_name",
7928+
"mail_prov_abvn",
7929+
"mail_postal_code",
7930+
"bg_dls_lsd",
7931+
"bg_dls_qtr",
7932+
"bg_dls_sctn",
7933+
"bg_dls_twnshp",
7934+
"bg_dls_rng",
7935+
"bg_dls_mrd",
7936+
"bg_x",
7937+
"bg_y",
7938+
"bu_n_civic_add",
7939+
"bu_use",
7940+
"csd_code",
7941+
"fed_code",
7942+
"fed_eng_name",
7943+
"fed_fre_name",
7944+
"er_code",
7945+
"er_eng_name",
7946+
"er_fre_name",
7947+
"reppoint_latitude",
7948+
"reppoint_longitude"
7949+
],
7950+
"properties": {
7951+
"id": {
7952+
"$ref": "#/components/schemas/ID"
7953+
},
7954+
"dataset": {
7955+
"type": "string",
7956+
"enum": [
7957+
"cannar"
7958+
]
7959+
},
7960+
"country_iso": {
7961+
"description": " 3 letter country code (ISO 3166-1)\n",
7962+
"enum": [
7963+
"CAN"
7964+
]
7965+
},
7966+
"country_iso_2": {
7967+
"type": "string",
7968+
"description": " 2 letter country code (ISO 3166-1)\n",
7969+
"enum": [
7970+
"CA"
7971+
]
7972+
},
7973+
"country": {
7974+
"type": "string",
7975+
"description": " Full country names (ISO 3166)\n",
7976+
"enum": [
7977+
"Canada"
7978+
]
7979+
},
7980+
"line_1": {
7981+
"type": "string",
7982+
"description": "First address line.\n\nCan be empty string `\"\"` if not present.\n",
7983+
"example": "38 Deane St"
7984+
},
7985+
"line_2": {
7986+
"type": "string",
7987+
"description": "Second address line.\n\nCan be empty string `\"\"` if not present.\n",
7988+
"example": "RR 4"
7989+
},
7990+
"language": {
7991+
"enum": [
7992+
"en",
7993+
"fr"
7994+
],
7995+
"description": "Language represented by 2 letter ISO Code (639-1)\n"
7996+
},
7997+
"address": {
7998+
"type": "string",
7999+
"description": "Address / House Number uniquely identifying the address along the specified street.\n\nCan be empty string `\"\"` if not present.\n",
8000+
"example": "16"
8001+
},
8002+
"longitude": {
8003+
"$ref": "#/components/schemas/Longitude"
8004+
},
8005+
"latitude": {
8006+
"$ref": "#/components/schemas/Latitude"
8007+
},
8008+
"loc_guid": {
8009+
"type": "string",
8010+
"description": "Globally unique identifier for location.\n"
8011+
},
8012+
"addr_guid": {
8013+
"type": "string",
8014+
"description": "Globally unique identifier for address.\n"
8015+
},
8016+
"apt_no_label": {
8017+
"type": "string",
8018+
"description": "Apartment or suite number.\n\nCan be empty string `\"\"` if not present.\n"
8019+
},
8020+
"civic_no": {
8021+
"type": "string",
8022+
"description": "The building number assigned to the address.\n\nCan be empty string `\"\"` if not present.\n"
8023+
},
8024+
"civic_no_suffix": {
8025+
"type": "string",
8026+
"description": "A suffix attached to the civic number.\n\nCan be empty string `\"\"` if not present.\n"
8027+
},
8028+
"official_street_name": {
8029+
"type": "string",
8030+
"description": "Official street name.\n\nCan be empty string `\"\"` if not present.\n"
8031+
},
8032+
"official_street_type": {
8033+
"type": "string",
8034+
"description": "Official street designator.\n\nCan be empty string `\"\"` if not present.\n"
8035+
},
8036+
"official_street_dir": {
8037+
"type": "string",
8038+
"description": "Official street direction.\n\nCan be empty string `\"\"` if not present.\n"
8039+
},
8040+
"prov_code": {
8041+
"type": "string",
8042+
"description": "Province code.\n"
8043+
},
8044+
"csd_eng_name": {
8045+
"type": "string",
8046+
"description": "Census subdivision English name.\n\nCan be empty string `\"\"` if not present.\n"
8047+
},
8048+
"csd_fre_name": {
8049+
"type": "string",
8050+
"description": "Census subdivision French name.\n\nCan be empty string `\"\"` if not present.\n"
8051+
},
8052+
"csd_type_eng_code": {
8053+
"type": "string",
8054+
"description": "English code indicating the type of Census Subdivision.\n\nCan be empty string `\"\"` if not present.\n"
8055+
},
8056+
"csd_type_fre_code": {
8057+
"type": "string",
8058+
"description": "French code indicating the type of Census Subdivision.\n\nCan be empty string `\"\"` if not present.\n"
8059+
},
8060+
"mail_street_name": {
8061+
"type": "string",
8062+
"description": "Name of the street used in the mailing address.\n\nCan be empty string `\"\"` if not present.\n"
8063+
},
8064+
"mail_street_type": {
8065+
"type": "string",
8066+
"description": "Designator of the street used in the mailing address.\n\nCan be empty string `\"\"` if not present.\n"
8067+
},
8068+
"mail_street_dir": {
8069+
"type": "string",
8070+
"description": "Direction of the street used in the mailing address.\n\nCan be empty string `\"\"` if not present.\n"
8071+
},
8072+
"mail_mun_name": {
8073+
"type": "string",
8074+
"description": "Municipality name used in the mailing address.\n\nCan be empty string `\"\"` if not present.\n"
8075+
},
8076+
"mail_prov_abvn": {
8077+
"type": "string",
8078+
"description": "Province abbreviation used in the mailing address.\n\nCan be empty string `\"\"` if not present.\n"
8079+
},
8080+
"mail_postal_code": {
8081+
"type": "string",
8082+
"description": "Postal code used in the mailing address.\n\nCan be empty string `\"\"` if not present.\n"
8083+
},
8084+
"bg_dls_lsd": {
8085+
"type": "string",
8086+
"description": "Legal Subdivision number within the Dominion Land Survey system for the address location.\n\nCan be empty string `\"\"` if not present.\n"
8087+
},
8088+
"bg_dls_qtr": {
8089+
"type": "string",
8090+
"description": "Quarter section within a section of the Dominion Land Survey system for the address location.\n\nCan be empty string `\"\"` if not present.\n"
8091+
},
8092+
"bg_dls_sctn": {
8093+
"type": "string",
8094+
"description": "Section number within a township of the Dominion Land Survey system for the address location.\n\nCan be empty string `\"\"` if not present.\n"
8095+
},
8096+
"bg_dls_twnshp": {
8097+
"type": "string",
8098+
"description": "Township number within the Dominion Land Survey system for the address location.\n\nCan be empty string `\"\"` if not present.\n"
8099+
},
8100+
"bg_dls_rng": {
8101+
"type": "string",
8102+
"description": "Range number within a meridian of the Dominion Land Survey system for the address location.\n\nCan be empty string `\"\"` if not present.\n"
8103+
},
8104+
"bg_dls_mrd": {
8105+
"type": "string",
8106+
"description": "Meridian number within the Dominion Land Survey system for the address location.\n\nCan be empty string `\"\"` if not present.\n"
8107+
},
8108+
"bg_x": {
8109+
"type": "string",
8110+
"description": "Spatial X coordinate (GPS) of building. (ESPG 3347)\n\nCan be empty string `\"\"` if not present.\n"
8111+
},
8112+
"bg_y": {
8113+
"type": "string",
8114+
"description": "Spatial Y coordinate (GPS) of building. (ESPG 3347)\n\nCan be empty string `\"\"` if not present.\n"
8115+
},
8116+
"bu_n_civic_add": {
8117+
"type": "string",
8118+
"description": "Additional delivery information for mailing address.\n\nCan be empty string `\"\"` if not present.\n",
8119+
"example": "PO Box 377"
8120+
},
8121+
"bu_use": {
8122+
"type": "string",
8123+
"description": "Building usage codes.\n\nCan be empty string `\"\"` if not present.\n"
8124+
},
8125+
"csd_code": {
8126+
"type": "string",
8127+
"description": "Unique identifier code for a Census Subdivision (CSD).\n\nCan be empty string `\"\"` if not present.\n"
8128+
},
8129+
"fed_code": {
8130+
"type": "string",
8131+
"description": "Unique identifier code for a federal electoral district.\n\nCan be empty string `\"\"` if not present.\n"
8132+
},
8133+
"fed_eng_name": {
8134+
"type": "string",
8135+
"description": "Name of the federal electoral district in English.\n\nCan be empty string `\"\"` if not present.\n"
8136+
},
8137+
"fed_fre_name": {
8138+
"type": "string",
8139+
"description": "Name of the federal electoral district in French.\n\nCan be empty string `\"\"` if not present.\n"
8140+
},
8141+
"er_code": {
8142+
"type": "string",
8143+
"description": "Unique identifier code for an economic region.\n\nCan be empty string `\"\"` if not present.\n"
8144+
},
8145+
"er_eng_name": {
8146+
"type": "string",
8147+
"description": "Name of the economic region in English.\n\nCan be empty string `\"\"` if not present.\n"
8148+
},
8149+
"er_fre_name": {
8150+
"type": "string",
8151+
"description": "Name of the economic region in French.\n\nCan be empty string `\"\"` if not present.\n"
8152+
},
8153+
"reppoint_latitude": {
8154+
"type": "string",
8155+
"description": "Latitude coordinate (WGS84).\n\nCan be empty string `\"\"` if not present.\n"
8156+
},
8157+
"reppoint_longitude": {
8158+
"type": "string",
8159+
"description": "Longitude coordinate (WGS84).\n\nCan be empty string `\"\"` if not present.\n"
8160+
}
8161+
}
8162+
},
78978163
"GbrGlobalAddress": {
78988164
"title": "Global Address",
78998165
"description": "Global (non-UK) address in the UK address format",
@@ -8031,6 +8297,9 @@
80318297
},
80328298
{
80338299
"$ref": "#/components/schemas/SdfiAddress"
8300+
},
8301+
{
8302+
"$ref": "#/components/schemas/CannarAddress"
80348303
}
80358304
]
80368305
},
@@ -8805,7 +9074,8 @@
88059074
"gnaf",
88069075
"kadaster",
88079076
"kartverket",
8808-
"sdfi"
9077+
"sdfi",
9078+
"cannar"
88099079
],
88109080
"properties": {
88119081
"paf": {
@@ -8946,6 +9216,11 @@
89469216
"type": "boolean",
89479217
"description": "Denmark: Danmarks Adresseregister (DAR)",
89489218
"example": true
9219+
},
9220+
"cannar": {
9221+
"type": "boolean",
9222+
"description": "Canada: Statistics Canada National Address Register",
9223+
"example": true
89499224
}
89509225
}
89519226
},
@@ -9269,6 +9544,11 @@
92699544
"type": "boolean",
92709545
"description": "Denmark: SDFI Address File",
92719546
"example": true
9547+
},
9548+
"cannar": {
9549+
"type": "boolean",
9550+
"description": "Canada: Statistics Canada National Address Register",
9551+
"example": true
92729552
}
92739553
}
92749554
}
@@ -10825,6 +11105,9 @@
1082511105
},
1082611106
{
1082711107
"$ref": "#/components/schemas/SdfiAddress"
11108+
},
11109+
{
11110+
"$ref": "#/components/schemas/CannarAddress"
1082811111
}
1082911112
]
1083011113
}

0 commit comments

Comments
 (0)