Guide de l'utilisateur du Service de données Web du Profil du Recensement de 2021

Date de diffusion : le 9 février 2022Mis à jour : le 15 novembre 2023

Le Profil du recensement, Recensement de la population de 2021 fournit un aperçu statistique de régions géographiques variées à partir de plusieurs variables détaillées. Les données sont disponibles selon le calendrier de diffusion du Recensement de la population de 2021. Pour plus de renseignements, se reporter à Planification de la diffusion des données du Recensement de 2021 : plans de diffusion. Note : Les données pour les thèmes : Scolarité, Langue, Langue de travail, Navettage et Instruction dans la langue officielle minoritaire seront offertes à une date ultérieure.

L'interface de programmation d'application (IPA) du Profil du Recensement de 2021 est conforme aux spécifications de l'IPA RESTful pour l'initiative « Statistical Data and Metadata eXchange (SDMX) ». Vous trouverez de la documentationFootnote 1 et un aide-mémoire (PDF, 83 Ko)Footnote 1 sur le site Web du groupe de travail technique SDMX. Le présent guide fait mention de termes et d'éléments techniques tels qu'ils sont définis dans la norme SDMX.

À l'aide de l'IPA SDMX, les utilisateurs peuvent demander d'avoir diverses dimensions comme paramètre dans le localisateur de ressources uniforme (adresse URL) telles que des régions géographiques et des caractéristiques. Les données qui en résultent peuvent être téléchargées sous forme de valeurs séparées par des virgules (CSV), de notation objet issue de JavaScript (JSON) et de langage de balisage extensible (XML).

La norme de l'échange de données et de métadonnées statistiques

La norme SDMXFootnote 1 est une norme de l'Organisation internationale de normalisation (ISO) (ISO 17369:2013) qui a été conçue pour décrire des données et des métadonnées statistiques. Statistique Canada et bon nombre d'autres organismes de statistique ont adopté cette norme pour permettre l'échange de données statistiques.

Elle est utilisée pour déterminer un modèle de données commun et elle repose sur l'utilisation d'interfaces normalisées d'accès aux données, connues sous le nom d'IPA.

Aperçu du modèle de données

Tous les éléments d'un domaine particulier peuvent être décrits au moyen de concepts. Ces concepts peuvent être répartis par dimensions, attributs et valeurs d'observation. Réunis, ils forment un schéma conceptuel.

Dans la SDMX, les données sont traitées à l'aide de flux de données, qui comportent chacun un ensemble de données avec une structure commune (p. ex. valeurs de données du recensement relatives aux caractéristiques ou aux régions géographiques d'un profil). Ces métadonnées structurales sont représentées au moyen d'une définition de structure de données (DSD), qui peut être réutilisée d'un flux de données à un autre. Imaginons que le flux de données est un conteneur à données avec une structure commune (les sujets similaires sont généralement groupés, la structure étant fondée sur un modèle hypercube). Pour les profils de recensement, les flux de données sont propres aux différents niveaux géographiques.

Un ensemble de dimensions sont utilisées pour définir la structure de données et le flux de données. Les données du Profil de recensement sont structurées à l'aide des dimensions suivantes :

Pour tenir à jour une liste contrôlée de codes, les valeurs permises pour chaque dimension sont conservées dans une liste de codes. Cela signifie, par exemple, que la liste de codes connectée à la dimension de fréquence comprendrait la liste de fréquences permises. Les listes de codes peuvent être utilisées par de nombreuses structures.

Chaque point de données a un identificateur unique appelé une clé, qui représente la combinaison des valeurs dans chaque dimension. L'ordre de la dimension dans la liste de dimensions est important pour produire la clé. La clé correspond à la liste de valeurs de dimension pour chaque dimension séparée par un point (.) et dresse la liste des dimensions selon l'ordre dans lequel elles apparaissent dans la liste de dimensions de la DSD. Par exemple, la clé « .2021A000235..1. » représente le filtrage de l'ensemble de données par la région géographique = Province de l'Ontario (2021A000235) et la caractéristique de profil = Population, 2021 (1). Dans cet exemple, la clé pourrait facilement être appliquée au flux de données DF_PR (Canada, provinces et territoires).

Une observation peut avoir des attributs qui y sont attachés, comme l'unité de mesure, les commentaires et les notes de bas de page.

SDMX peut être représentée au moyen de différents formats d'accès. En voici quelques exemples :

Service Web de données SDMX

Toutes les données stockées pour les profils de recensement peuvent être extraites à l'aide de la chaîne de requête décrite ci-dessous :

protocol://wsEntryPoint/resource/flowRef/key?parameters

Définition de la syntaxe

protocol
Le service Web est offert sur Hypertext Transfer Protocol (HTTP), http and https.
wsEntryPoint
Le point d'entrée du service Web est accessible au même emplacement que le point d'entrée des données et métadonnées SDMX, c.-à-d. « api.statcan.gc.ca/census-recensement/profile/sdmx/rest/ ».
resource
La ressource pour les requêtes est le data.
flowRef

Il s'agit d'une référence au flux de données décrivant les données qui doivent être renvoyées.

La syntaxe est l'identificateur de l'organisme maintenant le flux de données, suivi de l'identificateur du flux de données, puis de la version du flux de données, le tout séparé par une virgule (,).

Par exemple, dans la référence « STC_CP, DF_PR,1.1 », l'organisme est STC_CP, il maintient le flux de données DF_PR et la version du flux de données est 1.1. La première relâche du Profil du recensement (9 février 2022) fait référence à la version 1.0.

L'élément important ci-dessus est le nom du flux de données (DF_PR).

Si la valeur du paramètre ne comprend qu'un élément, celui-ci est considéré comme l'identificateur du flux de données. L'identificateur de l'organisme prendra par défaut la valeur de tous ces éléments (all), alors que la valeur pour la version du flux de données prendra par défaut la dernière valeur (latest).

Si la valeur du paramètre comprend deux éléments, ceux-ci sont considérés comme l'identificateur de l'organisme et l'identificateur du flux de données. La version prendra par défaut la dernière valeur (latest)

Vous trouverez ci-dessous la liste des flux de données pris en charge pour les profils de recensement :

Flux de données Nom du flux de données
DF_ADA aires de diffusion agrégées
DF_CD divisions de recensement
DF_CMACA régions métropolitaines de recensement et agglomérations de recensement
DF_CSD subdivisions de recensement (municipalités)
DF_CT secteurs de recensement
DF_DA aires de diffusion
DF_DCSD subdivisions de recensement abolies
DF_DPL localités désignées
DF_ER régions économiques
DF_FED (1.3) circonscriptions électorales fédérales (Ordonnance de représentation de 2013)
Par exemple : 
https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/data/STC_CP,DF_FED,1.3/A5.2013A000410001.1..1
DF_FED (2.0) circonscriptions électorales fédérales (Ordonnance de représentation de 2023)
Par exemple : 
https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/data/STC_CP,DF_FED,2.0/A5.2013A000410001.1..1
DF_FSA régions de tri d'acheminement©
DF_HR régions sociosanitaires
DF_POPCNTR centres de population
DF_PR Canada, provinces et territoires
key

Comme cela a été expliqué dans la section sur le modèle de données, la combinaison de dimensions permet d'identifier de manière unique des données statistiques. Une telle combinaison est connue sous le nom de clé de série dans SDMX et c'est ce qui est requis dans le paramètre de clé.

Par exemple, disons que les valeurs des profils de recensement peuvent être identifiées de manière unique à l'aide des éléments suivants :

  • la fréquence à laquelle elles sont mesurées (p. ex. tous les cinq ans = code A5)
  • les régions géographiques mentionnées (p. ex. province de l'Ontario = code 2021A000235)
  • un genre (p. ex. genre total =  code 1)
  • une caractéristique du Profil de recensement (p. ex. chiffre de population pour 2021 = code 1)
  • une donnée statistique (p. ex. chiffres  = code 1)

Pour produire une clé de série, vous devez prendre la valeur de chacune des dimensions (dans l'ordre dans lequel les dimensions sont définies dans la DSD) et les joindre avec un point (.). La clé de série pour l'exemple ci-dessus devient donc A5.2021A000235.1.1.1.

L'utilisation de caractères de remplacement est prise en charge en omettant la valeur pour la dimension qui doit être remplacée. Par exemple, la clé de série suivante peut être utilisée pour extraire les données relatives à toutes les caractéristiques de profil pour la province de l'Ontario : A5.2021A000235.1..1.

Utiliser le caractère plus (+) comme opérateur « OU ». Par exemple, la clé suivante peut être utilisée pour extraire les données relatives à toutes les caractéristiques de profil pour les provinces de l'Ontario et du Québec : A5.2021A000235+2021A000224.1..1

parameters

Dans cette chaîne de requête, les parameters sont définis comme suit :

	startPeriod=value&endPeriod=value&firstNObservations=value&lastNObservations=value&detail=value&format=value

Dans le cas des profils du recensement, les paramètres applicables sont le detail et le format.

detail

Pour préciser la quantité d'information que vous souhaitez que le service Web retourne, utiliser le paramètre detail.

Les options suivantes sont possibles :

  • full : Toutes les données, y compris la série et les observations, et les attributs doivent être renvoyés. Il s'agit de la valeur par défaut.
  • dataonly : Le message renvoyé exclura les attributs.
  • serieskeysonly : Le message renvoyé inclura seulement la série. Les attributs et les observations seront exclus. Par exemple, cette option vous permettrait d'énumérer les séries qui correspondent à une requête en particulier, mais pas de renvoyer les données réelles.
  • nodata : Le message renvoyé inclura la série ainsi que les attributs, mais pas les observations.
format

À l'aide du paramètre de format, vous pouvez indiquer au service Web de recevoir des données dans différents formats (voir aussi Négociation du contenu).

Les options possibles sont :

  • csv
  • jsondata

Exemples

Puisqu'il y aura un total de sept diffusions, ce qui entraînera sept versions de chaque flux de données, nous avons modifié les exemples ci-dessous, en supprimant le détail de la version. En conséquence, la version sera par défaut « la plus récente ».

  1. Extraire les données pour l'agglomération de recensement de Cornwall (tous les genres/toutes les statistiques) pour le flux de données DF_CMACA.

    https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/data/STC_CP,DF_CMACA/A5.2021S0504501...

  2. Extraire les données provinciales pour les provinces de l'Ontario et du Québec (tous les genres/toutes les statistiques) pour le flux de données DF_PR.

    https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/data/STC_CP,DF_PR/A5.2021A000235+2021A000224.1..1

Notez qu'il n'est pas avisé de procéder au téléchargement de la totalité des données relative à un flux de données. Si c'est ce que vous comptez faire, veuillez-vous rendre sur Profil du recensement, Recensement de la population de 2021 - Fichiers de téléchargement où la totalité des données pour chacun des flux de données est disponible pour être téléchargée.

Service Web de métadonnées SDMX

Toutes les métadonnées peuvent être extraites à l'aide de la chaîne de requête décrite ci-dessous :

protocol://wsEntryPoint/resource/agencyID/resourceID/version?detail=value&references=value

Définition de la syntaxe

protocol

Le service Web est offert sur https.

wsEntryPoint

Le point d'entrée du service Web est accessible au même emplacement que le point d'entrée des métadonnées SDMX, c-à-d. « api.statcan.gc.ca/census-recensement/profile/sdmx/rest/ ».

resource

Les ressources suivantes sont prises en charge par le service Web : datastructure, codelist et dataflow. Veuillez noter qu'elles ne sont pas toutes utilisées actuellement.

agencyID

Les organisations définissant les métadonnées sont connues comme des organismes dans SDMX. Pour extraire un artefact, vous devez connaître l'identificateur de l'organisme qui le tient à jour. Le code d'identification de l'organisme (agencyID) qui représente le profil de recensement pour Statistique Canada est STC_CP.

resourceID

L'identificateur de la ressource, comme CL_GEO_CMACA pour la liste de codes des régions métropolitaines de recensement et des agglomérations de recensement, est mis à jour par l'organisme qui, dans ce cas, est STC_CP.

version

Il s'agit de la version de l'artefact à renvoyer. Quand le numéro de version n'est pas fourni, la dernière version de la ressource est renvoyée.

detail

Vous pouvez préciser la quantité souhaitée de renseignements à retourner en utilisant le paramètre detail. Par exemple, il est possible de demander au service Web de ne renvoyer que les renseignements de base sur la ressource (c.-à-d. son ID, agencyID, version and name). Ceci est également connu dans SDMX comme un élément de remplacement.

Les valeurs permises sont les suivantes :

  • full : Tous les renseignements disponibles pour tous les artefacts seront renvoyés. Il s'agit de la valeur par défaut.
  • allstubs : Tous les artefacts seront renvoyés comme des éléments de remplacement.
  • referencestubs : Les artefacts indiqués seront renvoyés comme des éléments de remplacement.
references

En utilisant le paramètre references, vous pouvez demander au service Web de renvoyer (ou non) les artefacts indiqués par l'artefact à renvoyer (p. ex. les listes de codes et les concepts utilisés par la DSD correspondant à la requête). Vous pouvez également extraire les artefacts qui utilisent l'artefact correspondant (p. ex. les flux de données qui utilisent la DSD correspondant à la requête).

Les valeurs possibles sont les suivantes :

  • none : Aucune référence ne sera renvoyée. Il s'agit de la valeur par défaut.
  • parents : Les artefacts qui utilisent l'artefact correspondant à la requête (p. ex. les flux de données qui utilisent la DSD correspondant à la requête) seront renvoyés.
  • parentsandsiblings : Les artefacts qui utilisent l'artefact correspondant à la requête, ainsi que les artefacts indiqués par ces artefacts seront renvoyés.
  • children : Les artefacts indiqués par l'artefact correspondant seront renvoyés (p. ex. les classifications des concepts et les listes de codes utilisés dans la DSD).
  • descendants : Les références de références, jusqu'à n'importe quel niveau, seront également renvoyées.
  • all : La combinaison de parentsandsiblings et descendants sera renvoyée.

Un type concret de ressource peut également être utilisé (p. ex. references=codelist).

Exemples

  1. Extraire la plus récente version en production de la liste de codes CL_GEO_CMACA.

    https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/codelist/STC_CP/CL_GEO_CMACA/latest

  2. Extraire tous les flux de données à l'intérieur de l'environnement de SDMX mis à jour par l'organisme (AgencyID = STC_CP).

    https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/dataflow/STC_CP/all/latest

  3. Extraire toutes les métadonnées connexes pour le flux de données du Canada, des provinces et des territoires (DF_PR).

    https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/dataflow/STC_CP/DF_PR?references=all

Négociation du contenu

À l'aide du mécanisme de négociation de contenu HTTP, vous pouvez sélectionner la représentation de données à retourner. Vous pouvez également indiquer au service de comprimer les données à retourner.

Sélection du format

Les formats de données suivants sont pris en charge par le service Web :

Les types de mimes génériques (application/json, application/xml) sont également pris en charge, mais ils indiqueront toujours la plus récente version des formats SDMX pris en charge par ces services Web. Cette version changera dans l'avenir chaque fois que de nouvelles versions des divers formats SDMX seront disponibles.

Par conséquent, il est fortement recommandé que les exécutants utilisent un des types de mime précisé ci-dessus plutôt qu'un mime générique, pour éviter tout problème quand de nouvelles versions des formats sont publiées.

Compression des résultats

Vous pouvez également activer la compression des données en utilisant le champ Accept-Encoding HTTP header. Les messages comprimés sont généralement beaucoup plus petits que les messages non comprimés, ce qui peut mener à des améliorations au moment du transfert de grandes quantités de données sur le réseau.

Codes d'état

Le service Web renvoie les codes d'état HTTPFootnote 1 suivants.

Code État Description
200 OK Votre requête pourrait être traitée avec succès et les données avoir été renvoyées.
304 Aucune modification Aucune modification depuis l'horodatage fourni dans l'en-tête If-Modified-Since.
400 Erreur de syntaxe En cas de problème syntactique ou sémantique avec les paramètres que vous avez fournis, un code d'état HTTP 400 sera renvoyé.
404 Aucun résultat trouvé Un code d'état HTTP 404 sera renvoyé si aucun résultat ne correspond à la requête.
406 Inacceptable Si vous demandez une représentation de ressource que nous ne prenons pas en charge, le code d'état HTTP sera retourné. Reportez-vous à la section sur la négociation du contenu pour visualiser les représentations prises en charge.
500 Erreur interne du serveur En cas de problème de notre côté, le code d'état HTTP 500 sera retourné. N'hésitez pas à essayer de nouveau plus tard ou à communiquer avec notre assistance téléphonique.
501 Aucune mise en œuvre Ce service Web offre un sous-ensemble de la fonctionnalité offerte par la spécification du service Web SDMX RESTful. Quand vous utilisez une fonction que nous n'avons pas encore mise en œuvre, un code d'état HTTP 501 sera renvoyé.
503 Service non accessible Si notre service Web est temporairement indisponible, un code d'état HTTP 503 sera renvoyé.

Conseils utiles

Le groupe de travail technique SDMX publie une liste utile de conseils et astuces pour les clients du service WebFootnote 1 qui valent la peine d'être consultés.

Le groupe de travail technique SDMX a également publié un aide-mémoire(83 Ko)Footnote 1 de deux pages qui résume les principaux points de l'IPA SDMX 2.1 RESTful.

Si la documentation ne contient pas les renseignements dont vous avez besoin ou si vous avez des commentaires généraux ou de la rétroaction au sujet de notre service Web, veuillez nous contacter.

Tous les modèles de requêtes présentés dans le présent document peuvent également être exécutés à l'aide d'outils de ligne de commande comme curl ou wget : 


wget -O data.xml \
--header="Accept:application/vnd.sdmx.structurespecificdata+xml;version=2.1" \
https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/data/STC_CP,DF_CMACA/A5.2021S0504501...
curl -k -o data.xml \
--header "Accept:application/vnd.sdmx.structurespecificdata+xml;version=2.1" \
https://api.statcan.gc.ca/census-recensement/profile/sdmx/rest/data/STC_CP,DF_CMACA/A5.2021S0504501...

Information connexe

Date de modification :