Registre national des adresses - Guide de l'utilisateur

27 octobre 2021

Version 1.0 Préparé par la Division de l'infrastructure d'intégration des données

Table des matières

Table des matières

Historique des révisions

Historique des révisions
Date Version Revision details
27 octobre 2021 1.0 Première diffusion du Guide de l'utilisateur du RNA

Objet du document

L'objet du présent document est de fournir aux utilisateurs un guide pour le Registre national des adresses, lequel est désormais accessible à partir du Magasin des API (interfaces de programmation d'applications) du gouvernement du Canada.

Sommaire

Le Registre national des adresses (RNA) établit une structure d'adresses normalisée et fournit une liste d'adresses municipales géoréférencées valides au Canada. Les adresses sont extraites du Registre statistique des immeubles de Statistique Canada et ont été validées par deux sources de données indépendantes. Les adresses ne divulguent l'identité d'aucun des résidents ni des entreprises à l'adresse et, en tant que telles, sont considérées comme non confidentielles. La version postale correspondante de l'adresse est ajoutée et suit les directives d'adressage de Postes Canada. Ce prototype a été développé dans le cadre de la Feuille de route de la Stratégie de données pour la fonction publique fédérale et en étroite collaboration avec Emploi et Développement social Canada pour mettre en place les données d'adresses de référence en tant que service. Il est disponible sans frais en vertu de la licence ouverte de Statistique Canada. Il permet à un utilisateur d'effectuer une recherche par identifiant unique, par adresse ou par géographie.

Il est possible d'effectuer deux types de recherches dans le RNA : recherche de base et recherche avancée. La recherche de base est disponible en utilisant une fonction de recherche de base plein texte, tandis que la recherche avancée est disponible à l'aide d'un langage de requête qui est composé d'une série d'éléments simples liés ensemble pour former une requête plus complexe.

Accès et disponibilité

Avant de pouvoir utiliser une API, vous devez vous abonner à un plan d'API. Le plan détermine si des autorisations sont requises de même que le nombre d'appels d'API que votre application peut effectuer. Une fois que votre application est abonnée à un plan, une clé d'utilisateur unique est attribuée à l'application. Vous devez utiliser cette clé utilisateur lorsque vous appelez l'API. Cette API respecte les conditions générales du Magasin des API du gouvernement du Canada.

  • Les données sont mises à jour trimestriellement.
  • La limite de requêtes est de 100 clics par minute et par utilisateur. Le nombre maximal d'enregistrements pouvant être extraits par requête est de 100.

Technologie

Le protocole de transfert hypertexte sécurisé (HTTPS) est une façon standard de communiquer sur le Web et comprend des méthodes telles que GET et POST qui sont utilisées avec le service Web.

La mise en œuvre consiste en un service de données Web REST (suivant un style architectural de transfert d'état représentationnel [REST]) par protocole HTTPS, qui fournira des données en langage JSON (notation d'objet JavaScript).

REST est un style architectural précisant des contraintes, comme l'interface uniforme. Si ces contraintes sont appliquées à un service Web, elles produisent les propriétés voulues, comme le rendement, la variabilité dimensionnelle et la « modifiabilité » qui permettent aux services de fonctionner plus efficacement sur Internet.

Définitions

Division de recensement (DR) est le terme général de régions créées en vertu des lois provinciales (comme comté, municipalité régionale de comté et district régional) ou des régions équivalentes. Dans d'autres provinces et dans les territoires, où les lois ne prévoient pas de telles régions, Statistique Canada définit des régions équivalentes à des fins statistiques en collaboration avec ces provinces et territoires. Les divisions de recensement sont des régions géographiques intermédiaires entre la municipalité (subdivision de recensement) et la province/territoire.

Subdivision de recensement (SDR) est le terme générique qui désigne les municipalités (telles que définies par les lois provinciales/territoriales) ou les territoires considérés comme étant des équivalents municipaux à des fins statistiques (p. ex., les réserves indiennes, les établissements indiens et les territoires non organisés). Le statut de municipalité est défini par les lois en vigueur dans les provinces et les territoires au Canada.

Une région économique (RE) est constituée d'un groupe de divisions de recensement (DR) entières (sauf pour un cas en Ontario). Ces régions sont créées comme une unité géographique normalisée et servent à l'analyse de l'activité économique régionale.

Circonscription électorale fédérale (CEF) est une région représentée par un député à la Chambre des communes. Les limites des circonscriptions électorales fédérales utilisées dans le cadre du Recensement de 2021 sont fondées sur l'Ordonnance de représentation de 2013.

L'identificateur global unique (GUID) est un identifiant unique hexadécimal représenté sous forme de chaîne d'une longueur de 36 caractères, tirets inclus (p. ex.12345678-1234-1234-1234-123456789abc). Les GUID sont attribués et utilisés dans le RNA pour permettre le référencement d'entités spécifiques telles que les entités d'adresse ou de localisation (pour les définitions d'« adresse » et de « localisation », voir la section Spécifications techniques) et la récupération efficace des données de leurs attributs.

La latitude et la longitude sont des coordonnées dérivées du centroïde de côté d'îlot (lorsque le côté d'îlot était disponible). Le côté d'îlot correspond à un côté de rue situé entre deux traits consécutifs qui coupent cette rue. Ces traits peuvent être d'autres rues ou des limites de régions géographiques normalisées. Les côtés d'îlot servent à produire des points représentatifs de côté d'îlot, qui sont utilisés pour le géocodage et l'extraction de données du recensement lorsque les adresses de voirie sont connues.

La spécification OpenAPI (le contenu de cette page est en anglais), anciennement connue sous le nom de spécification Swagger, est une spécification pour les fichiers d'interface lisibles par machine pour décrire, produire, consommer et visualiser des services Web RESTful.

Méthodes et exemples d'interfaces de programmation d'applications

Différentes méthodes utilisées pour les API sont présentées ici :

Adresses

  • GetAddresses
  • GetAddressesByGUID
  • SearchAddresses

Emplacements

  • GetLocations
  • GetLocationsByGUID

Géographies

  • GetCensusSubDivisions
  • GetCensusSubDivisionsByCode
  • GetEconomicRegions
  • GetEconomicRegionsByCode
  • GetFederalElectoralDistricts
  • GetFederalElectoralDistrictsByCode

Le fichier Swagger du RNA se trouve à l'adresse suivante : fichier Swagger du RNA.

Adresses

Permet aux utilisateurs d'effectuer des recherches et d'extraire des adresses.

GetAddresses

Renvoie les adresses applicables à une requête.
Obtenir l'URL :

/addresses

Paramètres :

  • naql : permet aux utilisateurs d'effectuer des recherches plus avancées (pour obtenir plus de détails, voir la section Langage de requête des adresses nationales ci-dessous).
  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language).

Requête :
streetname eq "Main"
/addresses?naql=streetname%20eq%20%22Main%22

Réponse :

  • La requête naql soumise
  • 0 ou plusieurs identificateurs globaux uniques (GUIDs) d'adresse et d'emplacement
  • La version officielle de l'adresse municipale
  • La version postale de l'adresse municipale, le cas échéant
  • Les attributs de géocodage tels que les coordonnées X-Y, les classifications géographiques agrégées (subdivision de recensement [SDR], région économique [RE] et circonscription électorale fédérale [CEF])

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "complex",
    "criteria": "NAQL: streetname eq Main",
    "total": 1
  },
  "data": [
    {
      "addressId": "21d954e4-2a60-404d-bc84-0f6cdb068238",
      "civicNumber": {
        "prefix": null,
        "number": "170",
        "suffix": {
          "code": null
        }
      },
      "streetName": "Main",
      "streetType": {
        "code": "RUE"
      },
      "streetDirection": {
        "code": null
      },
      "cityName": {
        "en": "Hudson"
      },
      "province": {
        "code": "24"
      },

      "country": {
        "code": "CA",
        "name": {
          "en": "Canada"
        }
      },
      "mailingAddress": {
        "streetName": "MAIN",
        "streetType": {
          "code": "RUE"
        },
        "streetDirection": {
          "code": null
        },
        "municipalityName": "HUDSON",
        "province": {
          "code": "QC"
        },
        "country": {
          "code": "CA",
          "name": {
            "en": "Canada"
          }
        },
        "postalCode": "J0P1H0"
      },
      "location": {
        "locationID": "2de64244-1d04-4bc6-ab46-7795d4e3eb67",
        "geoCoordinates": {
          "latitude": 45.444111,
          "longitude": -74.105388
        },
        "geographies": [
          {
            "codes": {
              "code": "24074",
              "name": {
                "en": "Vaudreuil--Soulanges"
              }
            },
            "source": "FED_2016",
            "geographicType": "FED"
          },
          {
            "codes": {
              "code": "2435",
              "name": {
                "en": "Montérégie"
              }
            },
            "source": "ER_2016",
            "geographicType": "ER"
          },
          {
            "codes": {
              "code": "2471100",
              "name": {
                "en": "Hudson"
              }
            },
            "source": "CSD_2016",
            "geographicType": "CSD"
          }
        ]
      }
    },
  ]
}

GetAddressesByGUID

Renvoie les renseignements sur l'adresse pour une adresse GUID spécifiée.
Obtenir l'URL :
/addresses/{guid}

Paramètres :

  • guid : paramètre dans le chemin indiquant le GUID d'une adresse spécifique pour récupérer des renseignements
  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
228a72b8-3c1b-4734-b1cd-015490686513
/addresses/228a72b8-3c1b-4734-b1cd-015490686513

Réponse :

  • GUID d'adresse et d'emplacement
  • La version officielle de l'adresse municipale
  • La version postale de l'adresse municipale, le cas échéant
  • Les attributs de géocodage tels que les coordonnées X-Y, les classifications géographiques agrégées (SDR, RE et CEF)

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "simple",
    "criteria": "",
    "total": 1
  },
  "data": [
    {
      "addressId": "228a72b8-3c1b-4734-b1cd-015490686513",
      "civicNumber": {
        "prefix": null,
        "number": "308",
        "suffix": {
          "code": null
        }
      },
      "streetName": "Moyer",
      "streetType": {
        "code": "RD"
      },
      "streetDirection": {
        "code": null
      },
      "cityName": {
        "en": "Kelowna"
      },
      "province": {
        "code": "59"
      },
      "country": {
        "code": "CA",
        "name": {
          "en": "Canada"
        }
      },
      "mailingAddress": {
        "streetName": "MOYER",
        "streetType": {
          "code": "RD"
        },
        "streetDirection": {
          "code": null
        },
        "municipalityName": "KELOWNA",
        "province": {
          "code": "BC"
        },
        "country": {
          "code": "CA",
          "name": {
            "en": "Canada"
          }
        },
        "postalCode": "V1X4R7"
      },
      "location": {
        "locationID": "520b316f-b2ec-41bf-8a64-0000000aa537",
        "geoCoordinates": {
          "latitude": 49.910433,
          "longitude": -119.382058
        },
        "geographies": [
          {
            "codes": {
              "code": "59014",
              "name": {
                "en": "Kelowna--Lake Country"
              }
            },
            "source": "FED_2016",
            "geographicType": "FED"
          },
          {
            "codes": {
              "code": "5930",
              "name": {
                "en": "Thompson--Okanagan"
              }
            },
            "source": "ER_2016",
            "geographicType": "ER"
          },
          {
            "codes": {
              "code": "5935010",
              "name": {
                "en": "Kelowna"
              }
            },
            "source": "CSD_2016",
            "geographicType": "CSD"
          }
        ]
      }
    }
  ]
}

SearchAddresses

Renvoie les adresses applicables à une interrogation de requête.
Obtenir l'URL :
/addresses/search

Paramètres :

  • qstr : permet aux utilisateurs d'effectuer une recherche d'une chaîne d'interrogation en texte intégral
  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)
  • valueLang : permet aux utilisateurs d'indiquer la langue dans laquelle le paramètre qstr doit être interprété et comment l'interrogation doit être exécutée (cela n'a pas d'incidence sur la langue des résultats renvoyés de l'interrogation). Par exemple, /addresses/search?qstr=Gatineau&lang=en&valueLang=fr donnerait toutes les adresses contenant « Gatineau » en fonction de la représentation française des adresses dans le système, tout en donnant les résultats dans la représentation anglaise

Request:
308 MOYER RD KELOWNA BC V1X4R7
/addresses/search?qstr=308%20MOYER%20RD%20KELOWNA%20BC%20V1X4R7

Requête :

  • L'adresse soumise
  • 0 ou plusieurs GUID d'adresse et d'emplacement
  • La version officielle de l'adresse municipale
  • La version postale de l'adresse municipale, le cas échéant
  • Les attributs de géocodage tels que les coordonnées X-Y, les classifications géographiques agrégées (SDR, RE et CEF)

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "simple",
    "criteria": "Query: 308 MOYER RD KELOWNA BC V1X4R7  ",
    "total": 1
  },
  "data": [
    {
      "addressId": "228a72b8-3c1b-4734-b1cd-015490686513",
      "civicNumber": {
        "prefix": null,
        "number": "308",
        "suffix": {
          "code": null
        }
      },
      "streetName": "Moyer",
      "streetType": {
        "code": "RD"
      },
      "streetDirection": {
        "code": null
      },
      "cityName": {
        "en": "Kelowna"
      },
      "province": {
        "code": "59"
      },
      "country": {
        "code": "CA",
        "name": {
          "en": "Canada"
        }
      },
      "mailingAddress": {
        "streetName": "MOYER",
        "streetType": {
          "code": "RD"
        },
        "streetDirection": {
          "code": null
        },
        "municipalityName": "KELOWNA",
        "province": {
          "code": "BC"
        },
        "country": {
          "code": "CA",
          "name": {
            "en": "Canada"
          }
        },
        "postalCode": "V1X4R7"
      },
      "location": {
        "locationID": "520b316f-b2ec-41bf-8a64-0000000aa537",
        "geoCoordinates": {
          "latitude": 49.910433,
          "longitude": -119.382058
        },
        "geographies": [
          {
            "codes": {
              "code": "59014",
              "name": {
                "en": "Kelowna--Lake Country"
              }
            },
            "source": "FED_2016",
            "geographicType": "FED"
          },
          {
            "codes": {
              "code": "5930",
              "name": {
                "en": "Thompson--Okanagan"
              }
            },
            "source": "ER_2016",
            "geographicType": "ER"
          },
          {
            "codes": {
              "code": "5935010",
              "name": {
                "en": "Kelowna"
              }
            },
            "source": "CSD_2016",
            "geographicType": "CSD"
          }
        ]
      }
    }
  ]
}

Emplacements

Permet aux utilisateurs de récupérer des emplacements.

GetLocations

Renvoie les emplacements.
Obtenir l'URL :
/locations

Paramètres :

  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la requête doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
Récupérer des emplacements.
/locations

Réponse :

  • Les GUID de l’address et de l’emplacement
  • Les attributs de géocodage tels que les coordonnées X-Y, les classifications géographiques agrégées (subdivision de recensement [SDR], région économique [RE] et circonscription électorale fédérale [CEF])

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "none",
    "criteria": null,
    "total": 
  },
  "data": [
    {
      "locationID": "520b316f-b2ec-41bf-8a64-0000000aa537",
      "physicalAddress": [
        {
          "addressId": "228a72b8-3c1b-4734-b1cd-015490686513"
        }
      ],
      "geoCoordinates": {
        "latitude": 49.910433,
        "longitude": -119.382058
      },
      "geographies": [
        {
          "codes": {
            "code": "59014",
            "name": {
              "en": "Kelowna--Lake Country"
            }
          },
          "source": "FED_2016",
          "geographicType": "FED"
        },
        {
          "codes": {
            "code": "5930",
            "name": {
              "en": "Thompson--Okanagan"
            }
          },
          "source": "ER_2016",
          "geographicType": "ER"
        },
        {
          "codes": {
            "code": "5935010"
          },
          "source": "CSD_2016",
          "geographicType": "CSD"
        }
      ]
    },
    {
      "locationID": "856dfe0f-d261-475f-91ab-00000477aeb4",
      "physicalAddress": [
        {
          "addressId": "95c5a05e-8000-4420-b80e-3e54acfc0dcd"
        }
      ],
      "geoCoordinates": {
        "latitude": 52.023374,
        "longitude": -113.964395
      },
      "geographies": [
        {
          "codes": {
            "code": "48029",
            "name": {
              "en": "Red Deer--Mountain View"
            }
          },
          "source": "FED_2016",
          "geographicType": "FED"
        },
        {
          "codes": {
            "code": "4850",
            "name": {
              "en": "Red Deer"
            }
          },
          "source": "ER_2016",
          "geographicType": "ER"
        },
        {
          "codes": {
            "code": "4808008"
          },
          "source": "CSD_2016",
          "geographicType": "CSD"
        }
      ]
    }
  ]
}

GetLocationsByGUID

Renvoie les renseignements sur l'emplacement pour un emplacement GUID spécifié.
Obtenir l'URL :
/locations/{guid}

Paramètres :

  • guid : paramètre dans le chemin qui permet aux utilisateurs de récupérer des renseignements sur un emplacement GUID spécifique
  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
520b316f-b2ec-41bf-8a64-0000000aa537
/locations/520b316f-b2ec-41bf-8a64-0000000aa537

Réponse :

  • GUID d'adresse et d'emplacement
  • Les attributs de géocodage tels que les coordonnées X-Y, les classifications géographiques agrégées (SDR, RE et CEF)

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "simple",
    "criteria": "",
    "total": 1
  },
  "data": [
    {
      "locationID": "520b316f-b2ec-41bf-8a64-0000000aa537",
      "physicalAddress": [
        {
          "addressId": "228a72b8-3c1b-4734-b1cd-015490686513"
        }
      ],
      "geoCoordinates": {
        "latitude": 49.910433,
        "longitude": -119.382058
      },
      "geographies": [
        {
          "codes": {
            "code": "59014",
            "name": {
              "en": "Kelowna--Lake Country"
            }
          },
          "source": "FED_2016",
          "geographicType": "FED"
        },
        {
          "codes": {
            "code": "5930",
            "name": {
              "en": "Thompson--Okanagan"
            }
          },
          "source": "ER_2016",
          "geographicType": "ER"
        },
        {
          "codes": {
            "code": "5935010"
          },
          "source": "CSD_2016",
          "geographicType": "CSD"
        }
      ]
    }
  ]
}

Géographies

Les utilisateurs peuvent exécuter la requête et récupérer des renseignements sur l'ensemble de codes géographiques.

GetCensusSubDivisions

Renvoie les renseignements sur la subdivision de recensement (SDR).
Obtenir l'URL :
/geographies/censusSubDivisions

Paramètres :

  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
Récupérer des SDR.
/geographies/CensusSubDivisions

Réponse :

  • Codes de la SDR
  • Nom de la SDR (français et anglais)
  • Type de SDR
  • Source de la SDR

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "none",
    "criteria": null,
    "total": 3605
  },
  "data": [
    {
      "codes": {
        "code": "2430025",
        "name": {
          "en": "Frontenac"
        }
      },
      "csdType": {
        "en": "MÉ"
      },
      "source": "CSD_2016",
      "geographicType": "CSD"
    },
    {
      "codes": {
        "code": "2430030",
        "name": {
          "en": "Lac-Mégantic"
        }
      },
      "csdType": {
        "en": "V"
      },
      "source": "CSD_2016",
      "geographicType": "CSD"
    },
    {
      "codes": {
        "code": "2430035",
        "name": {
          "en": "Marston"
        }
      },
      "csdType": {
        "en": "CT"
      },
      "source": "CSD_2016",
      "geographicType": "CSD"
    }
  ]
}

GetCensusSubDivisionsByCode

Renvoie les renseignements sur la SDR pour un code de SDR spécifié.

Obtenir l'URL :
/geographies/censusSubDivisions/{csdCode}

Paramètres :

  • csdCode : paramètre dans le chemin qui permet aux utilisateurs de récupérer des renseignements sur un code de SDR spécifique
  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
Soumettre un code de SDR : 5935010.
/geographies/censusSubDivisions/5935010

Réponse :

  • Code de SDR
  • Nom de la SDR (français et anglais)
  • Type de SDR
  • Source de la SDR

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "simple",
    "criteria": "",
    "total": 1
  },
  "data": [
    {
      "codes": {
        "code": "5935010",
        "name": {
          "en": "Kelowna"
        }
      },
      "csdType": {
        "en": "CY"
      },
      "source": "CSD_2016",
      "geographicType": "CSD"
    }
  ]
}

GetEconomicRegions

Renvoie les renseignements sur la région économique (RE).
Obtenir l'URL :
/geographies/economicRegions

Paramètres :

  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
Récupérer des RE.
/geographies/economicRegions

Réponse :

  • Codes de la RE
  • Nom de la RE (français et anglais)
  • Source de la RE

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "none",
    "criteria": null,
    "total": 76
  },
  "data": [
    {
      "codes": {
        "code": "1010",
        "name": {
          "en": "Avalon Peninsula"
        }
      },
      "source": "ER_2016",
      "geographicType": "ER"
    },
    {
      "codes": {
        "code": "1020",
        "name": {
          "en": "South Coast--Burin Peninsula"
        }
      },
      "source": "ER_2016",
      "geographicType": "ER"
    },
    {
      "codes": {
        "code": "1030",
        "name": {
          "en": "West Coast--Northern Peninsula--Labrador"
        }
      },
      "source": "ER_2016",
      "geographicType": "ER"
    }
  ]
}

GetEconomicRegionsByCode

Renvoie les renseignements sur la RE pour un code de RE spécifié.
Obtenir l'URL :
/geographies/economicRegions/{erCode}

Paramètres :

  • erCode : paramètre dans le chemin qui permet aux utilisateurs de récupérer des renseignements sur un code de RE spécifique
  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
Soumettre un code de RE : 5930.
/geographies/economicRegions/5930

Réponse :

  • Code de RE
  • Nom de la RE (français et anglais)
  • Source de la RE

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "simple",
    "criteria": "",
    "total": 1
  },
  "data": [
    {
      "codes": {
        "code": "5930",
        "name": {
          "en": "Thompson--Okanagan"
        }
      },
      "source": "ER_2016",
      "geographicType": "ER"
    }
  ]
}

GetFederalElectoralDistricts

Renvoie les renseignements sur la circonscription électorale fédérale (CEF).
Obtenir l'URL :
/geographies/federalElectoralDistricts

Paramètres :

  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
Récupérer des CEF.
/geographies/federalElectoralDistricts

Réponse :

  • Codes de la CEF
  • Nom de la CEF (français et anglais)
  • Source de la CEF

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "none",
    "criteria": null,
    "total": 338
  },
  "data": [
    {
      "codes": {
        "code": "10001",
        "name": {
          "en": "Avalon"
        }
      },
      "source": "FED_2016",
      "geographicType": "FED"
    },
    {
      "codes": {
        "code": "10002",
        "name": {
          "en": "Bonavista--Burin--Trinity"
        }
      },
      "source": "FED_2016",
      "geographicType": "FED"
    }
  ]
}

GetFederalElectoralDistrictsByCode

Renvoie les renseignements sur la CEF pour un code de CEF spécifié.
Obtenir l'URL :
/geographies/federalElectoralDistricts{fedCode}

Paramètres :

  • fedCode : paramètre du répertoire qui permet aux utilisateurs de récupérer des renseignements sur un code de CEF spécifique
  • lang : permet aux utilisateurs d'indiquer la langue dans laquelle les résultats de la recherche doivent être renvoyés (remplace l'en-tête HTTP Accept-Language)

Requête :
Soumettre un code de CEF : 59014.
/geographies/federalElectoralDistricts/59014

Réponse :

  • Code de la CEF
  • Nom de la CEF (français et anglais)
  • Source de la CEF

{
  "meta": {
    "prepared": "",
    "test": false,
    "contentLanguage": [
      "en"
    ]
  },
  "search": {
    "searchStyle": "simple",
    "criteria": "",
    "total": 1
  },
  "data": [
    {
      "codes": {
        "code": "59014",
        "name": {
          "en": "Kelowna--Lake Country"
        }
      },
      "source": "FED_2016",
      "geographicType": "FED"
    }
  ]
}

Langage de requête des adresses nationales du Registre national des adresses

Le RNA permet aux utilisateurs d'effectuer des recherches simples qui exploitent les capacités de recherche en texte intégral à l'aide du paramètre qstr de la méthode API addresses/search. Cependant, il permet également des recherches plus avancées en utilisant les fonctionnalités du langage de recherche des adresses nationales (National Address Query Language — NAQL) à l'aide du paramètre naql de la méthode API /addresses.

Cette recherche avancée permet d'exécuter des requêtes structurées qui peuvent rechercher à travers les différents éléments des adresses du RNA. La recherche avancée est effectuée à l'aide du NAQL. Une requête dans NAQL (également appelée clause) se compose d'un champ, suivi d'un opérateur, suivi d'une ou plusieurs valeurs. Par exemple, la requête simple suivante permet de repérer toutes les adresses dont le numéro civique correspond à 1212. Elle utilise le champ « civic number », l'opérateur d'égalité et la valeur 1212.

Exemple :
civicNumber eq 1212

Comment effectuer une recherche avancée

La méthode API /addresses du RNA prend en charge l'utilisation des requêtes NAQL avancées à l'aide du paramètre naql pour exécuter la requête et renvoyer les adresses résultantes.

/addresses?naql=civicNumber%20eq%201212

Pour effectuer une recherche avancée :

  1. Ajoutez votre requête en utilisant les champs, opérateurs et valeurs comme valeur du paramètre de recherche NAQL.
  2. Exécutez une requête GET sur la ressource. Exécutez une requête GET sur la ressource. Vous pouvez appliquer des extensions et une pagination comme vous le feriez normalement dans l'API REST (Representational State Transfer) du RNA.

Effectuer des recherches de texte

L'opérateur CO (contient) peut être utilisé sur des champs de texte, tels que civicNumber.suffix, streetName et autres. L'opérateur CO est spécifique aux champs de texte, de chaînes ou de caractères et permet aux utilisateurs d'effectuer une correspondance sur une sous-chaîne dans le champ. Les utilisateurs peuvent toujours utiliser l'opérateur d'égalité eq pour rechercher une correspondance exacte sur un champ entier.

Propriétés prises en charge

Propriétés prises en charge
Propriété Description Exemple
civicnumber or civicnumber.number Représente le numéro civique de l'adresse ?naql=civicnumber eq 123 ou civicnumber.number eq 123
civicnumber.prefix Représente le numéro d'appartement ?naql=civicnumber.prefixeq 123
civicnumber.suffix Représente le suffixe du numéro d'adresse ?naql=civicnumber.suffix eq"A"
streetname Représente le nom de la rue de l'adresse ?naql=streetname eq"Main"
streettype or streettype.code Représente le type de rue de l'adresse ?naql=streettype eq"ST"
streetdirection or streetdirection.code Représente la direction de la rue de l'adresse ?naql=streetdirection eq"N"
cityname, cityname.en or cityname.fr Représente le nom de la ville de l'adresse ?naql=cityname eq"Ottawa"
province or province.code Représente le code province de l'adresse ?naql=province eq 11
mailingaddress.postalcode Représente le code postal de l'adresse postale de l'adresse ?naql=mailingaddress.postalcode eq"A0A 0A0"

Opérateurs pris en charge

Opérateurs pris en charge
Opérateur Description Exemple
eq Égale ?naql=streetname eq"Main"
co Contient ?naql=streetname co"Ma"
and Et ?naql=streetname eq"Main" and cityname eq"Vancouver"
or Ou ?naql=streetname eq"Main" or streetname eq"Laurier"
( ) Parenthèses ?naql=(streetname eq"Main" or streetname eq"Laurier") and cityname eq"Ottawa"

Spécifications techniques

Registre national des adresse — Modèle de données

Emplacement (locationId) vs adresse (addressId)
L'emplacement fait référence à un lieu ou une position spécifique. Dans le cas du RNA, l'emplacement est synonyme d'un bâtiment physique. L'adresse peut être définie comme les détails de l'emplacement où une personne vit ou où une organisation est située. Dans le cas du RNA, l'adresse correspond aux « unités de bâtiment ». Chaque emplacement (bâtiment) a au moins une adresse (unité de bâtiment). Par exemple, une maison individuelle aura un emplacement et une adresse physique. Un immeuble d'appartements ou de bureaux aurait un emplacement et plusieurs adresses pour chaque unité de l'immeuble. Une maison individuelle serait un rapport « un-à-un » et un immeuble d'appartements serait un rapport « un-à-plusieurs ».

Exemple 1
Une maison individuelle (logement individuel ou unité de bâtiment) avec une seule adresse, 1 MAIN ST, TORONTO, ON M1M1A1, aurait un locationId unique et un addressId unique (rapport 1:1).
1 MAIN ST, TORONTO, ON M1M1A1
locationId: 12345678-1234-1234-1234-123456789abc
addressId: 12345678-1234-1234-1234-123456789Bbc

Exemple 2
Un immeuble de bureaux comptant de multiples étages et unités ou suites à l'emplacement 123 MAIN ST, TORONTO, ON M2M1A1 aurait un locationId unique et plusieurs addressId uniques (rapport 1:n). Chaque « unité de bâtiment » aurait sa propre adresse qui se différencierait par le numéro du local.

  1. 2-123 MAIN ST, TORONTO, ON M2M1A1
    locationId: 22345678-1234-1234-1234-123456789abc
    addressId: 22345678-1234-1234-1234-123456789Zbc
  2. 4-123 MAIN ST, TORONTO, ON M2M1A1
    locationId: 22345678-1234-1234-1234-123456789abc
    addressId: 22345678-1234-1234-1234-123456789Ybc
  3. 5-123 MAIN ST, TORONTO, ON M2M1A1
    locationId: 22345678-1234-1234-1234-123456789abc
    addressId: 22345678-1234-1234-1234-123456789Xbc
  4. 8-123 MAIN ST, TORONTO, ON M2M1A1
    locationId: 22345678-1234-1234-1234-123456789abc
    addressId: 22345678-1234-1234-1234-123456789Rbc

Exemple 3

Adresse qui utilise tous les propriétés et attributs :
12-123 A MAIN ST N, OTTAWA, ON A0A 0A0

Attributs RNA

Attributs RNA
Attributs Objet Description
locationId   Identificateur global unique pour l'emplacement
addressId   Identificateur global unique pour l'adresse
civicNumber.prefix   Numéro d'appartement ou de local
civicNumber.number   Numéro civique
civicNumber.suffix   Suffixe du numéro civique
streetName   Nom officiel de la rue
streetType   Désignation de la rue faisant partie du nom officiel de la rue
streetDirection   Composante de direction de la rue faisant partie du nom officiel de la rue
province   Code province
cityName.en   Nom anglais de la subdivision de recensement
cityName.fr   Nom français de la subdivision de recensement
mailingAddress.streetName   Nom de la rue de l'adresse postale
mailingAddress.streetType   Désignation de la rue de l'adresse postale
mailingAddress.streetDirection   Composante de direction de la rue faisant partie du nom de la rue de l'adresse postale
mailingAddress.municipalityName   Nom de la municipalité de l'adresse postale
mailingAddress.province   Abréviation de la province de l'adresse postale
mailingAddress.postalCode   Code postal de l'adresse postale
location.geographies[]   Série d'objets de classification géographique associés à un emplacement
location.geographies[].{object} Code Code de la circonscription électorale fédérale, de la région économique et de la subdivision de recensement dans une série précise
  Name.En Nom anglais de la circonscription électorale fédérale, de la région économique et de la subdivision de recensement dans une série précise
  Name.Fr Nom français de la circonscription électorale fédérale, de la région économique et de la subdivision de recensement dans une série précise
location.geoCoordinates.latitude   Coordonnée de latitude
location.geoCoordinates.longitude   Coordonnée de longitude

Liens utiles

Annexe

Ensembles de codes

Liste des codes d'état HTTP

Le RNA est une API REST (suivant un style architectural de REST) qui utilise des codes d'état HTTP standard pour transmettre les résultats de la requête d'un client dans une API.

Les codes d'état du RNA sont indiqués ci-dessous.

Les codes d'état du RNA
Code État Description du ResponseStatusCode
2XX Succès Cela indique que la requête du client a été acceptée avec succès.
4XX Erreur du client Cette catégorie de codes d'état signale une erreur provenant du côté du client.
5XX Erreur du serveur Le serveur assume la responsabilité de ces codes d'état d'erreur.
Codes 2XX
Codes 2XX Description
200 (ok) Le corps contient l'objet de la réponse (métadonnées, objet de recherche, objet de données).
204 (aucun contenu) Le serveur a répondu à la requête, mais n'a pas à renvoyer un corps de réponse. Le serveur peut renvoyer les méta-informations mises à jour.
Codes 4XX
Codes 4XX Description
400 (mauvaise requête) Le serveur n'a pas pu comprendre la requête en raison d'une syntaxe incorrecte. Le client ne doit pas répéter la requête sans modifications.
  • Lorsqu'un nom de champ est erroné : Un champ saisi n'est pas pris en charge.
  • Lorsqu'un opérateur n'est pas pris en charge : Un opérateur saisi n'est pas pris en charge.
  • Lorsqu'un opérateur erroné est inséré : La syntaxe de la requête était incorrecte.
  • Lors d'une tentative d'utilisation avec une valeur numérique : la syntaxe de la requête était incorrecte.
  • Lors d'une tentative de requête avec une valeur de chaîne qui n'est pas entourée de guillemets doubles : La valeur de chaîne n'est pas valide. Elle doit être entourée de guillemets doubles.
401 (non autorisé) Cela indique que la requête nécessite des informations d'authentification de l'utilisateur.Le client peut répéter la requête avec un champ d'en-tête d'autorisation approprié.
Exemple : L'utilisateur appelle l'API sans utiliser sa clé API.
403 (interdit) Requête non autorisée : Le client n'a pas les droits d'accès au contenu. Contrairement à 401, l'identité du client est connue du serveur.
404 (non trouvé) Le serveur ne peut pas trouver la ressource demandée lors de la recherche d'une adresse, d'un emplacement, d'une géographie avec un identificateur global unique (GUID) ou un code.
Codes 5XX
Codes 5XX Description
500 (erreur interne du serveur) Le serveur a constaté une condition inattendue qui l'a empêché de répondre à la requête.
501 (non mise en œuvre) Un utilisateur a tenté d'accéder à une fonctionnalité qui n'est pas mise en œuvre.

Genre de subdivision de recensement

Les subdivision de recensement (SDR) sont classées en 57 genres, selon les appellations officielles adoptées par les autorités provinciales, territoriales ou fédérales. Il y a toutefois deux exceptions, soit la « subdivision non organisée » (SNO) à Terre‑Neuve‑et‑Labrador et la « subdivision municipalité de comté » (SC) en Nouvelle-Écosse, qui sont des régions géographiques équivalant aux municipalités et ayant été créées par Statistique Canada de concert avec ces provinces, à des fins de diffusion des données statistiques.

Le tableau 1.5 présente les genres de SDR, leurs abréviations et leur province.

Géographies

Classification géographique type (CGT)

Province

Codes de province
Province Code Province Abbreviation Description_English Description_Français
10 NL Newfoundland and Labrador Terre-Neuve-et-Labrador
11 PE Prince Edward Island Île-du-Prince-Édouard
12 NS Nova Scotia/td> Nouvelle-Écosse
13 NB New Brunswick Nouveau-Brunswick
24 QC Quebec Québec
35 ON Ontario Ontario
46 MB Manitoba Manitoba
47 SK Saskatchewan Saskatchewan
48 AB Alberta Alberta
59 BC British Columbia Colombie-Britannique
60 YT Yukon Yukon
61 NT Northwest Territories Territoires du Nord-Ouest
62 NU Nunavut Nunavut

Postes Canada Symboles et abréviations

Points cardinaux, types de rue, provinces et territoires canadiens

Coordonnées

Les commentaires et les suggestions sont les bienvenus pour améliorer et étendre l'utilisation du RNA, ainsi que les questions ou les préoccupations. Veuillez communiquer avec nous à l'adresse courriel suivante : statcan.statisticalregistersinfo-inforegistresstatistiques.statcan@statcan.gc.ca.

Date de modification :