Préparé par le Centre des normes en matière de statistiques et de données
Table des matières
Historique des révisions
Historique des révisions
| Date
|
Version
|
Renseignements détaillés sur les révisions
|
|---|
| 14 novembre 2024
|
2.3
|
- Corrections apportées à la documentation
|
|---|
| 16 août 2024
|
2.2
|
- Corrections apportées à la documentation
|
|---|
| 15 août 2024
|
2.1
|
- Ajout de points d'aboutissement d'index
|
|---|
| 5 juillet 2024
|
2.0
|
- Supprimer l'exigence relative à la clé API
- nouvelle URL
|
|---|
| 1 juin 2022
|
1.0
|
- Première diffusion du Guide de l'utilisateur des DRS
|
|---|
Objet du document
L'objet du présent document est de fournir aux utilisateurs un guide pour les données de référence en tant que service (DRS).
Sommaire
Les données de référence en tant que service (DRS) consistent en une liste d'ensembles de codes, de classifications et de concordances qui sont utilisés à Statistique Canada et partagés pour permettre d'harmoniser les données en vue d'améliorer l'intégration et l'analyse des données à l'échelle interministérielle. Cette initiative de DRS a pour but de mettre les données de référence de Statistique Canada à la disposition de quiconque souhaite faciliter le partage des données et harmoniser les données entre le gouvernement du Canada et ses partenaires de données à des fins d'analyse.
Accès et disponibilité
L'interface de programmation d'application (API) est accessible au public. En général, l'API devrait être disponible 24/7 sauf pendant les mises à jour du système.
Le localisateur de ressources universel (URL) de l'API se trouve à :
https://api.statcan.gc.ca/rdaas
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
Cette interface de programmation d'applications (API) vous donnera une liste complète d'ensembles de codes dans la langue demandée. Voici les classifications et les ensembles de codes qui sont inclus et accessibles aux fins de consommation générale Définitions, sources de données et méthodes (statcan.gc.ca). Un exemple de classification que vous pouvez trouver est Genre, où vous pourrez télécharger les renseignements suivants par l'intermédiaire de cette API Classification du genre (statcan.gc.ca).
Méthodes et exemples relatifs à l'interface de programmation d'applications
Différentes méthodes utilisées pour l'API sont présentées ci-dessous.
Recherche
La fonction de recherche des DRS offre aux utilisateurs la possibilité de chercher les ressources en fonction d'une variété de paramètres. Chaque type de ressource aura un point d'extrémité où la recherche comme telle est effectuée, ainsi que la possibili
Recherche de classifications
Recherche et filtre les classifications. La recherche de texte est appliquée aux noms et aux descriptions de classification. Les filtres applicables se trouvent à l'aide de la méthode Obtenir des filtres de recherche de classifications. Cette recherche prend en charge la pagination, et un décalage et une limite peuvent être précisés.
Recherche de classifications - plus d'informations
Méthode HTTP : GET
URL relative :
/search/classifications
Paramètres :
- Nom
- Description
- limite
nombre entier
(requête)
- le nombre de résultats à retourner; facultatif, 10 par défaut, 500 maximum
Valeur par défaut 10
- q
chaîne
(requête)
- le texte de recherche; facultatif, omettre pour faire une recherche exhaustive
- début
nombre entier
(requête)
- la position de début pour les résultats retournés; facultatif, 0 (commencer au premier résultat) par défaut
Valeur par défaut 0
- destinataire
chaîne
(requête)
- Même si cette Swagger UI ne le permet pas, un paramètre peut être répété pour filtrer en fonction de plus d'une valeur à la fois.
Noter qu'il se pourrait que les utilisateurs n'aient pas tous accès aux valeurs montrées ici. Voir la méthode /filtres correspondante pour déterminer les valeurs de filtre qui s'appliquent à vous.
Valeurs disponibles PUBLIC, INTERNE, SYSTÈME, DCCI
- état
chaîne
(requête)
- Même si cette Swagger UI ne le permet pas, un paramètre peut être répété pour filtrer en fonction de plus d'une valeur à la fois.
Noter qu'il se pourrait que les utilisateurs n'aient pas tous accès aux valeurs montrées ici. Voir la méthode /filtres correspondante pour déterminer les valeurs de filtre qui s'appliquent à vous.
Valeurs disponibles DÉFINI, VÉRIFIÉ, EN ATTENTE, APPROUVÉ, DIFFUSÉ, SUPPRIMÉ, RETIRÉ, ARCHIVÉ
Codes de réponse :
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Classifications retrouvées avec succès.
|
Exemple :
Cet appel retournera les 10 premières classifications disponibles où vous pouvez trouver l'ID à utiliser dans d'autres appels.
Appel :
https://api.statcan.gc.ca/rdaas/search/classifications?limit=10
{
"results": {
"@context": "https://api.statcan.gc.ca/rdaas/context/classification-search",
"@graph": [
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/UT1MXA1jXY1fUpI5",
"name": "Accommodations of collective dwellings",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-05-02T12:36:44Z",
"validFrom": "2017-03-20T04:00:00Z",
"codeCount": 15,
"levelCount": 2,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/O9Kepe4bA1syfqYh"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/E16EWiM6ykmPDq4k",
"name": "Accommodations of collective dwellings - Collapsed classification",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-05-02T12:36:50Z",
"validFrom": "2017-03-20T04:00:00Z",
"codeCount": 6,
"levelCount": 1,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/Kg860zM75ZI07dvh"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/P1PiDASifm2o9oHQ",
"name": "Admission category",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2024-01-09T16:15:28Z",
"validFrom": "2023-10-10T04:00:00Z",
"codeCount": 40,
"levelCount": 4,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/cDazrF4xtw6CMPzK"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/jar887g7uV1OQYov",
"name": "After-tax income",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2024-05-27T17:33:53Z",
"validFrom": "2016-03-21T04:00:00Z",
"codeCount": 27,
"levelCount": 2,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/Q85DCmZ2MYZdcqyo"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/Gnka5DWGAyFWxnLT",
"name": "After-tax income of person",
"abbreviation": null,
"versionNumber": "2.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-09-28T10:53:46Z",
"validFrom": "2016-03-21T04:00:00Z",
"codeCount": 27,
"levelCount": 3,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/AJczsftMQ9bhxv1p"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/z003kOtktxHvwlqs",
"name": "Age categories by five-year age groups",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-08-12T15:48:17Z",
"validFrom": "2007-05-22T04:00:00Z",
"codeCount": 21,
"levelCount": 1,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/frUSfEXyon94IaZk"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/qeneaaD0bcvKzkhu",
"name": "Agricultural Regions - Variant of SGC",
"abbreviation": null,
"versionNumber": "2016.1.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2023-05-05T18:04:27Z",
"validFrom": "2016-05-16T04:00:00Z",
"codeCount": 7314,
"levelCount": 6,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/gigntSkqxTSeHjlm"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/DhkqJv2iI2ebZju8",
"name": "Apprenticeship certificates",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2024-01-08T18:53:28Z",
"validFrom": "2021-05-26T04:00:00Z",
"codeCount": 2,
"levelCount": 1,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/FvNfg3B25APRSxH4"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/WNtEKGZu4qIJx3Oz",
"name": "Canadian citizenship status",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-05-02T13:18:45Z",
"validFrom": "2011-04-18T04:00:00Z",
"codeCount": 2,
"levelCount": 1,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/tXaph1UBAf4x5ZwD"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/t4QLjaKVS4JX6CGV",
"name": "Canadian Classification of Institutional Units and Sectors",
"abbreviation": "CCIUS",
"versionNumber": "2012.1.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-05-02T13:37:16Z",
"validFrom": "2015-06-15T04:00:00Z",
"codeCount": 171,
"levelCount": 6,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/zQevgSms7fLn6Yie"
}
]
},
"found": 2395,
"start": 0,
"limit": 10,
"facets": {
"status": {
"RELEASED": 1882,
"RETIRED": 487,
"ARCHIVED": 26
},
"audience": {
"NON_STANDARDIZED": 1912,
"STANDARDS": 483
}
}
}
Filtres de recherche de classifications
Retournera une liste de filtres et les valeurs qui peuvent être utilisées pour ces filtres lorsque l'on cherche des classifications. Ils peuvent être utilisés comme paramètres de requête pour toute demande de recherche. Par exemple, s'il y a un filtre nommé « bank » avec des valeurs « A », « B » et "C", des paramètres de requête peuvent être ajoutés à toute demande de recherche pour filtrer les résultats en fonction de ces valeurs. Par exemple, pour filtrer en fonction de « bank » « A » et « B », on pourrait ajouter
?bank=A&bank=B à l'URL de requête. Il convient de noter que ces filtres seront aussi inclus comme nombre de facettes dans tous les résultats de recherche.
Filtres de recherche de classifications - plus d'informations
Méthode HTTP : GET
URL relative :
/search/classifications/filters
Paramètres :
Aucun
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Classifications retrouvées avec succès.
|
Exemple :
Cet appel retournera une liste de filtres de classifications qui peuvent être utilisés dans d'autres appels.
Appel :
https://api.statcan.gc.ca/rdaas/search/classifications/filters
[ {
"parameter" : "status",
"values" : [ "RELEASED", "RETIRED", "ARCHIVED" ]
}, {
"parameter" : "audience",
"values" : [ "STANDARDS", "NON_STANDARDIZED" ]
} ]
Recherche de concordances
Recherche et filtre les concordances. La recherche de texte est appliquée aux noms et aux descriptions de concordances. Les filtres applicables se trouvent grâce à la méthode Obtenir des filtres de recherche de concordances. Cette recherche prend en charge la pagination, et un décalage et une limite peuvent être précisés.
Chercher des concordances - plus d'informations
Méthode HTTP : GET
URL relative :
/search/concordances
Paramètres :
- Nom
- Description
- limite
nombre entier
(requête)
- le nombre de résultats à retourner; facultatif, 10 par défaut, 500 maximum
Valeur par défaut 10
- q
chaîne
(requête)
- le texte de recherche; facultatif, omettre pour faire une recherche exhaustive
- début
nombre entier
(requête)
- la position de début pour les résultats retournés; facultatif, 0 (commencer au premier résultat) par défaut
Valeur par défaut 0
- destinataire
chaîne
(requête)
- Même si cette Swagger UI ne le permet pas, un paramètre peut être répété pour filtrer en fonction de plus d'une valeur à la fois.
Noter qu'il se pourrait que les utilisateurs n'aient pas tous accès aux valeurs montrées ici. Voir la méthode /filtres correspondante pour déterminer les valeurs de filtre qui s'appliquent à vous.
Valeurs disponibles PUBLIC, INTERNE, SYSTÈME, DCCI
- état
chaîne
(requête)
- Même si cette Swagger UI ne le permet pas, un paramètre peut être répété pour filtrer en fonction de plus d'une valeur à la fois.
Noter qu'il se pourrait que les utilisateurs n'aient pas tous accès aux valeurs montrées ici. Voir la méthode /filtres correspondante pour déterminer les valeurs de filtre qui s'appliquent à vous.
Valeurs disponibles DÉFINI, VÉRIFIÉ, EN ATTENTE, APPROUVÉ, DIFFUSÉ, SUPPRIMÉ, RETIRÉ, ARCHIVÉ
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Concordances retrouvées avec succès.
|
Exemple :
Cet appel retournera les 10 premières concordances disponibles où vous pouvez utiliser l'ID pour d'autres appels.
Appel :
https://api.statcan.gc.ca/rdaas/search/concordances?limit=10
{
"results" : {
"@context" : "https://api.statcan.gc.ca/rdaas/context/concordance-search",
"@graph" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/OjYqoufLb12yRhrq",
"name" : "National Occupational Classification V2016.1.0 to V2016.1.1",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:18:49Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/g8CZeIwUhswtL0Mi",
"source_name" : "National Occupational Classification",
"sourceVersionNumber" : "2016.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/QqdPX82Lk5bKqPul",
"target_name" : "National Occupational Classification",
"targetVersionNumber" : "2016.1.1"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/a2bMQbmThySaqbHO",
"name" : "National Occupational Classification V2016.1.1 to V2016.1.2",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:22:23Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/QqdPX82Lk5bKqPul",
"source_name" : "National Occupational Classification",
"sourceVersionNumber" : "2016.1.1",
"target" : "https://api.statcan.gc.ca/rdaas/classification/rrIXoQv2XQY7aKLJ",
"target_name" : "National Occupational Classification",
"targetVersionNumber" : "2016.1.2"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/HGJTm7VMSMhwsYEk",
"name" : "National Occupational Classification V2016.1.2 to V2016.1.3",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:26:06Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/rrIXoQv2XQY7aKLJ",
"source_name" : "National Occupational Classification",
"sourceVersionNumber" : "2016.1.2",
"target" : "https://api.statcan.gc.ca/rdaas/classification/pkba22EgXl2c7apI",
"target_name" : "National Occupational Classification",
"targetVersionNumber" : "2016.1.3"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/Xu7sVCPbxydMH0E2",
"name" : "North American Industry Classification System - Canada V2007.1.0 to V2012.1.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2023-05-30T18:14:40Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/rJcCKBjOKGOIe05K",
"source_name" : "North American Industry Classification System - Canada",
"sourceVersionNumber" : "2007.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/P4nBWMtGTR97i4aA",
"target_name" : "North American Industry Classification System - Canada",
"targetVersionNumber" : "2012.1.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/wyFGyCucaNxZn1vl",
"name" : "North American Industry Classification System - Canada V2012.1.0 to V2017.1.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:39:24Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/P4nBWMtGTR97i4aA",
"source_name" : "North American Industry Classification System - Canada",
"sourceVersionNumber" : "2012.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/TGLFzrGej7kGOzM0",
"target_name" : "North American Industry Classification System - Canada",
"targetVersionNumber" : "2017.1.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/gjBOiUvngK15MZg2",
"name" : "North American Industry Classification System - Canada V2017.1.0 to V2017.2.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:41:40Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/TGLFzrGej7kGOzM0",
"source_name" : "North American Industry Classification System - Canada",
"sourceVersionNumber" : "2017.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/bDiwaJL3bjdeZ8TS",
"target_name" : "North American Industry Classification System - Canada",
"targetVersionNumber" : "2017.2.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/qzUQ47PtPMkqPZHj",
"name" : "North American Industry Classification System - Canada V2017.2.0 to V2017.3.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:44:03Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/bDiwaJL3bjdeZ8TS",
"source_name" : "North American Industry Classification System - Canada",
"sourceVersionNumber" : "2017.2.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/S049Pjk4RIUgw6j2",
"target_name" : "North American Industry Classification System - Canada",
"targetVersionNumber" : "2017.3.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/qEwaBpiTQKKzeGIp",
"name" : "North American Product Classification System - Canada V2012.1.0 to V2012.1.1",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-02T18:57:46Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/X8l4KOP2cmhJzwSH",
"source_name" : "North American Product Classification System - Canada",
"sourceVersionNumber" : "2012.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/oIHxzqfQiLHk9vMc",
"target_name" : "North American Product Classification System - Canada",
"targetVersionNumber" : "2012.1.1"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/UKa2VvehQUt1ZKVt",
"name" : "North American Product Classification System - Canada V2012.1.1 to V2012.1.2",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-02T19:07:08Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/oIHxzqfQiLHk9vMc",
"source_name" : "North American Product Classification System - Canada",
"sourceVersionNumber" : "2012.1.1",
"target" : "https://api.statcan.gc.ca/rdaas/classification/iXY2lQJFVTLMAYK2",
"target_name" : "North American Product Classification System - Canada",
"targetVersionNumber" : "2012.1.2"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/IFg2ANyUAkAB4hcW",
"name" : "North American Product Classification System - Canada V2012.1.2 to V2017.1.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-02T19:09:49Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/iXY2lQJFVTLMAYK2",
"source_name" : "North American Product Classification System - Canada",
"sourceVersionNumber" : "2012.1.2",
"target" : "https://api.statcan.gc.ca/rdaas/classification/FojCXY7J9UDmynZZ",
"target_name" : "North American Product Classification System - Canada",
"targetVersionNumber" : "2017.1.0"
} ]
},
"found" : 1200,
"start" : 0,
"limit" : 10,
"facets" : {
"status" : {
"RETIRED" : 1150,
"RELEASED" : 48,
"ARCHIVED" : 2
},
"audience" : {
"NON_STANDARDIZED" : 1183,
"STANDARDS" : 17
}
}
}
Filtres de recherche de concordance
Retournera une liste de filtres et les valeurs qui peuvent être utilisées pour ces filtres lorsque l'on cherche des concordances. Ils peuvent être utilisés comme paramètres de requête pour toute demande de recherche. Par exemple, s'il y a un filtre nommé « bank » avec des valeurs « A », « B » et « C », des paramètres de requête peuvent être ajoutés à toute demande de recherche pour filtrer les résultats en fonction de ces valeurs. Par exemple, pour filtrer en fonction de « bank » « A » et « B », on pourrait ajouter
?bank=A&bank=B à l'URL de requête. Il convient de noter que ces filtres seront aussi inclus comme nombre de facettes dans tous les résultats de recherche.
Filtres de recherche de concordance - plus d'informations
Méthode HTTP : GET
URL relative :
/search/concordances/filters
Paramètres :
Aucun
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Concordances retrouvées avec succès.
|
Exemple :
Cet appel retournera la liste de filtres disponibles qui peuvent être utilisés dans d'autres appels.
Appel :
https://api.statcan.gc.ca/rdaas/search/concordances/filters
[ {
"parameter" : "status",
"values" : [ "RELEASED", "RETIRED", "ARCHIVED" ]
}, {
"parameter" : "audience",
"values" : [ "STANDARDS", "NON_STANDARDIZED" ]
} ]
Classifications - ensembles de codes
En règle générale, une classification statistique est une manière de regrouper un ensemble de catégories connexes dans un format utile, systématique et standard. La classification statistique est généralement exhaustive, comporte des catégories mutuellement exclusives et bien décrites, et a une structure hiérarchique ou plate. Une classification statistique comprend généralement des codes et des descripteurs.
Cette section comprend des requêtes qui fournissent des renseignements à propos des classifications, de leurs niveaux et codes, et des changements d'une version à l'autre. Ces ressources sont elles-mêmes offertes dans différents affichages (généralement détaillés et sommaires) et accompagnées de quelques utilitaires conçus pour fournir aux utilisateurs des réponses aux questions précises qu'ils pourraient avoir sans qu'ils soient obligés de fouiller eux-mêmes dans les renseignements.
Codes / Catégories
Les codes sont une valeur alphanumérique ou numérique qui est liée à une catégorie. Les codes sont organisés dans une classification par niveaux. Dans une classification plate, il y aura un seul niveau qui comprend tous les codes. Dans une classification hiérarchique, les codes qui sont stockés aux niveaux les plus élevés seront plus vastes, tandis que ceux qui sont stockés dans les niveaux inférieurs seront plus précis que leurs parents.
Détails sur la classification
Fournit des renseignements détaillés à propos de la classification précisée. Cela comprend des renseignements descriptifs à propos de la classification, des renseignements sur la version, les niveaux et tous les codes classés par ordre et hiérarchie (le cas échéant).
Classification detail - plus d'informations
Méthode HTTP : GET
URL relative :
/classification/{id}
Paramètres :
- Nom
- Description
- id *
chaîne
(chemin)
- Identificateur de la classification.
- lang
chaîne
(requête)
- Les étiquettes de langue d'internationalisation pour demander du contenu dans des langues particulières. Peut être séparé par des virgules. Par exemple, « lang=en, fr-ca ». Voir /api/i18n/tags sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Exemple fr
- method
chaîne
(requête)
- La méthode de sérialisation d'internationalisation à utiliser. Voir /api/i18n/methods sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Valeurs disponibles SIMPLE, PROPRIÉTÉ, TABLEAU, CONTENANT
Exemple SIMPLE
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Classification retrouvée avec succès.
|
Exemple :
Cet appel retournera tous les renseignements disponibles pour la classification de genre (lQA3IRH1ER3KXwrJ).
Appel :
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ
{
"@context" : [ {
"id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/id",
"name" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"abbreviation" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name/~/type=abbreviation",
"audience" : "https://api.statcan.gc.ca/rdaas/model/property/path/audience",
"status" : "https://api.statcan.gc.ca/rdaas/model/property/path/lifecycle/status",
"lastUpdated" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/administrative/properties/_/administrativeLastUpdate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"description" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/description/~/type=background",
"versionName" : "https://api.statcan.gc.ca/rdaas/model/property/path/version/name",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"levels" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/administrative/properties/_/includes/~/inclusionRole=defines/type=level",
"@context" : [ {
"levelDepth" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/levelNumber",
"name" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"codeCount" : "https://api.statcan.gc.ca/rdaas/model/property/count/codes"
}, {
"@language" : "en"
} ]
},
"codes" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/rootCode",
"@context" : [ {
"code" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"descriptor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"definition" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/description/~/type=definition",
"children" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/child"
}, {
"@language" : "en"
} ]
}
}, {
"@language" : "en"
} ],
"@id" : "https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ",
"name" : "Sex at birth",
"audience" : "Standardized",
"status" : "Released",
"lastUpdated" : "2023-03-27T11:49:44.205Z",
"description" : "<br /><p><strong>Status: </strong>This standard was approved as a <a href=\"https://www.statcan.gc.ca/eng/subjects/standard/napcs/notice/compulsory\" rel=\"nofollow\">departmental standard</a> on October 1, 2021.</p><p>Information on sex at birth may be based on self-reported data or reported by proxy depending on the statistical program. Therefore, the expression 'reported sex at birth' is used in these definitions when referring to self-reported data and answers reported by proxy.</p>",
"versionName" : "V1.0.0",
"validFrom" : "2021-10-01T00:00:00-04:00",
"levels" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/level/XV0o7C1uTxhWxZI5",
"levelDepth" : 1,
"name" : "Category",
"codeCount" : 2
} ],
"codes" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/code/vobFEu0ZvMjIOxsH",
"code" : "1",
"descriptor" : "Male",
"definition" : "This category includes persons whose reported sex at birth is male."
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/code/cFJZgJBj8RFFpFJE",
"code" : "2",
"descriptor" : "Female",
"definition" : "This category includes persons whose reported sex at birth is female."
} ]
}
Catégories de classification
Retourne toutes les catégories à tous les niveaux de la classification sous forme de liste plate. Si la classification est hiérarchique, les catégories ici ne seront pas présentées selon leur hiérarchie.
Classification Categories - plus d'informations
Méthode HTTP : GET
URL relative :
/classification/{id}/categories
Paramètres :
- Nom
- Description
- id *
chaîne
(chemin)
- Identificateur de la version de classification.
- lang
chaîne
(requête)
- Les étiquettes de langue d'internationalisation pour demander du contenu dans des langues particulières. Peut être séparé par des virgules. Par exemple, « lang=en, fr-ca ». Voir /api/i18n/tags sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Exemple fr
- method
chaîne
(requête)
- La méthode de sérialisation d'internationalisation à utiliser. Voir /api/i18n/methods sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Valeurs disponibles SIMPLE, PROPRIÉTÉ, TABLEAU, CONTENANT
Exemple SIMPLE
Codes de réponse :
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Catégories de classification retrouvées avec succès.
|
| 404
|
Classification non trouvée.
|
Exemple :
Cet appel retournera les catégories de classification de genre (lQA3IRH1ER3KXwrJ) disponibles.
Appel :
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ/categories
{
"@context" : [ {
"code" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"descriptor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"definition" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/description/~/type=definition",
"levelDepth" : "https://api.statcan.gc.ca/rdaas/model/property/path/code/level/number"
}, {
"@language" : "en"
} ],
"@graph" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/code/vobFEu0ZvMjIOxsH",
"code" : "1",
"descriptor" : "Male",
"definition" : "This category includes persons whose reported sex at birth is male.",
"levelDepth" : 1
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/code/cFJZgJBj8RFFpFJE",
"code" : "2",
"descriptor" : "Female",
"definition" : "This category includes persons whose reported sex at birth is female.",
"levelDepth" : 1
} ]
}
Catégories de classification détaillées
Retourne les catégories les plus détaillées de la classification. Ce sont les catégories sans aucune sous-catégorie. Dans la plupart des classifications hiérarchiques, ce seront les catégories du niveau le plus bas. Cependant, dans une classification décalée, il se pourrait que ces catégories existent à n'importe quel niveau.
Catégories de classification détaillées - plus d'informations
Méthode HTTP : GET
URL relative :
/classification/{id}/categories/detailed
Paramètres :
- Nom
- Description
- id *
chaîne
(chemin)
- Identificateur de la classification.
- lang
chaîne
(requête)
- Les étiquettes de langue d'internationalisation pour demander du contenu dans des langues particulières. Peut être séparé par des virgules. Par exemple, « lang=en, fr-ca ». Voir /api/i18n/tags sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Exemple fr
- method
chaîne
(requête)
- La méthode de sérialisation d'internationalisation à utiliser. Voir /api/i18n/methods sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Valeurs disponibles SIMPLE, PROPRIÉTÉ, TABLEAU, CONTENANT
Exemple SIMPLE
Codes de réponse :
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Concordance retrouvée avec succès.
|
| 404
|
Classification non trouvée.
|
Exemple :
Cet appel retournera les détails des catégories de classification de genre (lQA3IRH1ER3KXwrJ) disponibles.
Appel :
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ/categories/detailed
{
"@context" : [ {
"code" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"descriptor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"definition" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/description/~/type=definition",
"levelDepth" : "https://api.statcan.gc.ca/rdaas/model/property/path/code/level/number"
}, {
"@language" : "en"
} ],
"@graph" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/code/vobFEu0ZvMjIOxsH",
"code" : "1",
"descriptor" : "Male",
"definition" : "This category includes persons whose reported sex at birth is male.",
"levelDepth" : 1
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/code/cFJZgJBj8RFFpFJE",
"code" : "2",
"descriptor" : "Female",
"definition" : "This category includes persons whose reported sex at birth is female.",
"levelDepth" : 1
} ]
}
Les entrées d'index
Les entrées d'index sont des définitions formelles et des affinements supplémentaires des catégories qui relèvent d'un code particulier. Elles ne sont pas définies comme des codes dans une classification, mais sont plus informatives pour spécifier quels termes sont inclus dans un code particulier. Elles peuvent également spécifier des codes comme des exclusions explicites, indiquant qu'ils ne doivent pas être considérés comme une valeur liée à ce code. Ces informations peuvent être utilisées pour aider les utilisateurs à déterminer à quel code appartient leur catégorie spécifique.
Tous les index
Retourne les détails de toutes les entrées d'index pour une classification sous forme d'un tableau appelé @graph. Un tableau @graph vide signifie que la classification a été trouvée, mais qu'elle n'a aucun index.
Tous les index – plus d'informations
Méthode HTTP : GET
URL :
/api/classification/{id}/indexes
Paramètres :
| Nom
|
Obligatoire
|
Type de données
|
Type de paramètre (chemin/requête)
|
Description
|
|---|
| id
|
Oui
|
chaîne
|
chemin
|
Identifiant de la classification.
|
Codes de réponse :
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Entrées d'index retrouvées avec succès.
|
| 404
|
Classification non trouvée.
|
Exemple :
Cet appel retourne les détails de toutes les entrées d'index pour une classification dont le id=owrgkARZ8Omww7qX
Appel :
https://api.statcan.gc.ca/rdaas/classification/owrgkARZ8Omww7qX/indexes
Résultats :
{
"@context": [
{
"indexId": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/id",
"illustrativeExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=illustrativeExample",
"inclusions": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=inclusion",
"otherExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=otherExample",
"internalExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=internal",
"indexCode": {
"@id": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexCode",
"@type": "@id"
},
"indexCodeValue": "https://api.statcan.gc.ca/rdaas/model/property/path/index/code/code_value",
"indexCodeDescriptor": "https://api.statcan.gc.ca/rdaas/model/property/path/index/code/descriptor",
"exclusions": {
"@id": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexExclusion",
"@context": [
{
"code": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
"descriptor": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name"
},
{
"@language": "en"
}
]
}
},
{
"@language": "en"
}
],
"@graph": [
{
"@id": "https://api.statcan.gc.ca/rdaas/indexentry/aQksihrYIqMLkgiJ",
"indexId": 7,
"otherExamples": [
"hogs for breeding"
],
"indexCode": "https://api.statcan.gc.ca/rdaas/code/ourZOQCA1BMbuRoF",
"indexCodeValue": "1111211",
"indexCodeDescriptor": "Hogs for breeding"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/indexentry/d1uakrz9EU9P7xMF",
"indexId": 12,
"otherExamples": [
"hogs for market"
],
"indexCode": "https://api.statcan.gc.ca/rdaas/code/zyDg0ZfhR0B9xm83",
"indexCodeValue": "1111213",
"indexCodeDescriptor": "Hogs for market"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/indexentry/vkRhvTgxFs3Hly0S",
"indexId": 17,
"otherExamples": [
"chickens for breeding"
],
"indexCode": "https://api.statcan.gc.ca/rdaas/code/xsurl5uuYmUq5c3Y",
"indexCodeValue": "1111311",
"indexCodeDescriptor": "Chickens for breeding"
}
]
}
Index unique
Retourne une entrée d'index pour une classification par son identifiant d'index. Si le corps de la requête renvoie 1 (au lieu de JSON), cela peut signifier que la classification n'a aucun index.
Index unique – plus d'informations
Méthode HTTP : GET
URL :
/api/classification/{id}/indexes
Paramètres :
| Nom
|
Obligatoire
|
Type de données
|
Type de paramètre (chemin/requête)
|
Description
|
|---|
| id
|
Oui
|
chaîne
|
chemin
|
Identifiant de la classification.
|
| indexId
|
Oui
|
entier
|
chemin
|
ID d'index de l'entrée d'index.
|
Codes de réponse :
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Entrées d'index retrouvées avec succès.
|
| 404
|
Classification ou entrée d'index non trouvée.
|
Exemple :
Retourne une entrée d'index pour une classification dont le id=owrgkARZ8Omww7qX et indexId=7
Appel :
https://api.statcan.gc.ca/rdaas/classification/owrgkARZ8Omww7qX/indexes/entry/7
Résultats :
{
"@context": [
{
"indexId": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/id",
"illustrativeExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=illustrativeExample",
"inclusions": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=inclusion",
"otherExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=otherExample",
"internalExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=internal",
"indexCode": {
"@id": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexCode",
"@type": "@id"
},
"indexCodeValue": "https://api.statcan.gc.ca/rdaas/model/property/path/index/code/code_value",
"indexCodeDescriptor": "https://api.statcan.gc.ca/rdaas/model/property/path/index/code/descriptor",
"exclusions": {
"@id": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexExclusion",
"@context": [
{
"code": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
"descriptor": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name"
},
{
"@language": "en"
}
]
}
},
{
"@language": "en"
}
],
"@graph": [
{
"@id": "https://api.statcan.gc.ca/rdaas/indexentry/aQksihrYIqMLkgiJ",
"indexId": 7,
"otherExamples": [
"hogs for breeding"
],
"indexCode": "https://api.statcan.gc.ca/rdaas/code/ourZOQCA1BMbuRoF",
"indexCodeValue": "1111211",
"indexCodeDescriptor": "Hogs for breeding"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/indexentry/d1uakrz9EU9P7xMF",
"indexId": 12,
"otherExamples": [
"hogs for market"
],
"indexCode": "https://api.statcan.gc.ca/rdaas/code/zyDg0ZfhR0B9xm83",
"indexCodeValue": "1111213",
"indexCodeDescriptor": "Hogs for market"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/indexentry/vkRhvTgxFs3Hly0S",
"indexId": 17,
"otherExamples": [
"chickens for breeding"
],
"indexCode": "https://api.statcan.gc.ca/rdaas/code/xsurl5uuYmUq5c3Y",
"indexCodeValue": "1111311",
"indexCodeDescriptor": "Chickens for breeding"
}
]
}
Concordances
Une concordance est un tableau de correspondance qui exprime officiellement les relations entre les versions subséquentes de variantes de classifications. Elle peut exister entre deux versions de la même classification, ou entre deux classifications différentes. Les relations montrent le rapport entre les éléments de la cible et les éléments de la source.
Une concordance contient la série de correspondances entre les codes de la source et la classification cible. Il existe bon nombre de différents types de correspondances, de correspondances simples une à une à de nombreuses relations complexes les unes avec les autres; on trouve principalement des correspondances complexes à travers différentes versions d'une classification.
Types de correspondances
Il existe différents types de changements ou de correspondances. Les définitions suivantes décrivent les types de correspondances qui sont possibles dans Ariā
- Suppression (1:0) : un code existant expire.
- Création (0:1) : un nouveau code est créé.
- Combinaisons (N:1)
- Fusion : deux ou plusieurs codes expirent, alors que leurs dénotations donnent lieu à un code émergent.
- Remplacement : un code expire, alors que sa dénotation va de l'avant comme partie de la dénotation d'un autre élément, qui poursuit son existence.
- Décomposition (1:N)
- Ventilation : un code expire, alors que sa dénotation est distribuée et va de l'avant dans deux éléments de classification émergents ou plus.
- Séparation : un code continue d'exister, alors qu'une partie de sa dénotation passe à un autre code (émergent)
- Transfert (M:N)
- Simple :
- Changement de code (1:0, 0:1) : un code expire, alors que sa dénotation va de l'avant en tant que dénotation d'un élément émergent.
- Changement de propriété (1:1) : le nom ou d'autres propriétés d'un code changent, alors que sa dénotation demeure la même.
- Aucun changement (1:1) : aucun changement ne se produit.
Détails sur la concordance
Fournit des renseignements détaillés à propos de la concordance précisée. Cela comprend des renseignements descriptifs à propos de la concordance, des renseignements sur la version et les correspondances de son code.
Détails sur la concordance - plus d'informations
Méthode HTTP : GET
URL relative :
/concordance/{id}
Paramètres :
- Nom
- Description
- id *
chaîne
(chemin)
- Identificateur de la concordance.
- lang
chaîne
(requête)
- Les étiquettes de langue d'internationalisation pour demander du contenu dans des langues particulières. Peut être séparé par des virgules. Par exemple, « lang=en, fr-ca ». Voir /api/i18n/tags sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Exemple fr
- method
chaîne
(requête)
- La méthode de sérialisation d'internationalisation à utiliser. Voir /api/i18n/methods sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Valeurs disponibles SIMPLE, PROPRIÉTÉ, TABLEAU, CONTENANT
Exemple SIMPLE
Codes de réponse :
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Concordance retrouvée avec succès.
|
| 404
|
Concordance non trouvée.
|
Exemple :
Cet appel retournera les détails de la concordance pour la norme de données de référence sur les provinces et les territoires canadiens V2002.0.0 à V2002.0.1 (s9aLOlj8BB6DplVz).
Appel :
https://api.statcan.gc.ca/rdaas/concordance/s9aLOlj8BB6DplVz
{
"@context" : [ {
"id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/id",
"name" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"audience" : "https://api.statcan.gc.ca/rdaas/model/property/path/audience",
"status" : "https://api.statcan.gc.ca/rdaas/model/property/path/lifecycle/status",
"lastUpdated" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/administrative/properties/_/administrativeLastUpdate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"versionName" : "https://api.statcan.gc.ca/rdaas/model/property/path/version/name",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"source" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/source",
"@type" : "@id"
},
"target" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/target",
"@type" : "@id"
},
"versionConcordance" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/isVersionConcordance",
"predominateSource" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/isPredominateSource",
"predominateTarget" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/isPredominateTarget",
"codeMaps" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/administrative/properties/_/includes/~/inclusionRole=defines/type=codeMap",
"@context" : [ {
"maptype" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/type",
"sourceCode" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/code",
"sourceDescriptor" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/name",
"sourceSinceVersion" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/version/since",
"targetCode" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/code",
"targetDescriptor" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/name",
"targetSinceVersion" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/version/since",
"distributionFactor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/distributionFactor",
"reverseDistributionFactor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/reverseDistributionFactor"
}, {
"@language" : "en"
} ]
}
}, {
"@language" : "en"
} ],
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/s9aLOlj8BB6DplVz",
"name" : "Reference data standard on Canadian provinces and territories V2002.0.0 to V2002.0.1",
"audience" : "Non-standardized",
"status" : "Released",
"lastUpdated" : "2022-04-14T19:06:36.372Z",
"versionName" : "V1.0.0",
"validFrom" : "2003-04-01T00:00:00-05:00",
"source" : "https://api.statcan.gc.ca/rdaas/classification/DHE3EVBVfiUdi7n1",
"target" : "https://api.statcan.gc.ca/rdaas/classification/pElnW6jZSn77dSFd",
"versionConcordance" : true,
"codeMaps" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/RZT2TRNA8mnuideL",
"maptype" : "No Change",
"sourceCode" : "MB",
"sourceDescriptor" : "Manitoba",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "MB",
"targetDescriptor" : "Manitoba",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/poioFhrbrr6yoTv5",
"maptype" : "No Change",
"sourceCode" : "QC",
"sourceDescriptor" : "Quebec",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "QC",
"targetDescriptor" : "Quebec",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/Vhv5c0y4RoagICjZ",
"maptype" : "No Change",
"sourceCode" : "SK",
"sourceDescriptor" : "Saskatchewan",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "SK",
"targetDescriptor" : "Saskatchewan",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/DuxUs08tODCdSZKU",
"maptype" : "No Change",
"sourceCode" : "NS",
"sourceDescriptor" : "Nova Scotia",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NS",
"targetDescriptor" : "Nova Scotia",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/lBxOFiFMqryqblaq",
"maptype" : "No Change",
"sourceCode" : "NL",
"sourceDescriptor" : "Newfoundland and Labrador",
"sourceSinceVersion" : "2002.0.0",
"targetCode" : "NL",
"targetDescriptor" : "Newfoundland and Labrador",
"targetSinceVersion" : "2002.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/R52XeJK2hJY0FvFb",
"maptype" : "No Change",
"sourceCode" : "PE",
"sourceDescriptor" : "Prince Edward Island",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "PE",
"targetDescriptor" : "Prince Edward Island",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/rczeSiD0Bi5LslOv",
"maptype" : "No Change",
"sourceCode" : "BC",
"sourceDescriptor" : "British Columbia",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "BC",
"targetDescriptor" : "British Columbia",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/xzQH64AQ3MO8yobP",
"maptype" : "No Change",
"sourceCode" : "NU",
"sourceDescriptor" : "Nunavut",
"sourceSinceVersion" : "1999.0.0",
"targetCode" : "NU",
"targetDescriptor" : "Nunavut",
"targetSinceVersion" : "1999.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/KFytLKZ437SzR11p",
"maptype" : "No Change",
"sourceCode" : "NT",
"sourceDescriptor" : "Northwest Territories",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NT",
"targetDescriptor" : "Northwest Territories",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/CVuFLE9Nm0krCZ98",
"maptype" : "Update",
"sourceCode" : "YT",
"sourceDescriptor" : "Yukon Territory",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "YT",
"targetDescriptor" : "Yukon",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/XBApMvSyym0DFrcU",
"maptype" : "No Change",
"sourceCode" : "AB",
"sourceDescriptor" : "Alberta",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "AB",
"targetDescriptor" : "Alberta",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/NBEufKEmXO4g4Adm",
"maptype" : "No Change",
"sourceCode" : "ON",
"sourceDescriptor" : "Ontario",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "ON",
"targetDescriptor" : "Ontario",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/X8TSQiUFKEgvH4gJ",
"maptype" : "No Change",
"sourceCode" : "NB",
"sourceDescriptor" : "New Brunswick",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NB",
"targetDescriptor" : "New Brunswick",
"targetSinceVersion" : "1990.0.0"
} ]
}
Correspondances de codes
Retourne les correspondances de codes pour la concordance précisée. Ne fournira aucun renseignement supplémentaire à propos de la concordance. Si les utilisateurs souhaitent obtenir les détails complets de la concordance, ils peuvent appeler api/concordance/{id} ou s'ils veulent des renseignements sommaires, ils peuvent appeler api/concordance/{id}/summary.
Correspondances de codes - plus d'informations
Méthode HTTP : GET
URL relative :
/concordance/{id}/maps
Paramètres :
- Nom
- Description
- id *
chaîne
(chemin)
- Identificateur de la concordance.
- lang
chaîne
(requête)
- Les étiquettes de langue d'internationalisation pour demander du contenu dans des langues particulières. Peut être séparé par des virgules. Par exemple, « lang=en, fr-ca ». Voir /api/i18n/tags sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Exemple fr
- method
chaîne
(requête)
- La méthode de sérialisation d'internationalisation à utiliser. Voir /api/i18n/methods sous InternationalizationController pour obtenir plus de détails à propos du soutien linguistique.
Valeurs disponibles SIMPLE, PROPRIÉTÉ, TABLEAU, CONTENANT
Exemple SIMPLE
Codes de réponse :
| Code d'état HTTP
|
Description
|
|---|
| 200
|
Cartes de concordance retrouvées avec succès.
|
| 404
|
Concordance non trouvée.
|
Exemple :
Cet appel retournera les correspondances de détails de la concordance pour la norme de données de référence sur les provinces et les territoires canadiens V2002.0.0 à V2002.0.1 (s9aLOlj8BB6DplVz).
Appel :
https://api.statcan.gc.ca/rdaas/concordance/s9aLOlj8BB6DplVz/maps
{
"@context" : [ {
"maptype" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/type",
"sourceCode" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/code",
"sourceDescriptor" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/name",
"sourceSinceVersion" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/version/since",
"targetCode" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/code",
"targetDescriptor" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/name",
"targetSinceVersion" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/version/since",
"distributionFactor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/distributionFactor",
"reverseDistributionFactor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/reverseDistributionFactor"
}, {
"@language" : "en"
} ],
"@graph" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/RZT2TRNA8mnuideL",
"maptype" : "No Change",
"sourceCode" : "MB",
"sourceDescriptor" : "Manitoba",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "MB",
"targetDescriptor" : "Manitoba",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/poioFhrbrr6yoTv5",
"maptype" : "No Change",
"sourceCode" : "QC",
"sourceDescriptor" : "Quebec",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "QC",
"targetDescriptor" : "Quebec",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/Vhv5c0y4RoagICjZ",
"maptype" : "No Change",
"sourceCode" : "SK",
"sourceDescriptor" : "Saskatchewan",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "SK",
"targetDescriptor" : "Saskatchewan",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/DuxUs08tODCdSZKU",
"maptype" : "No Change",
"sourceCode" : "NS",
"sourceDescriptor" : "Nova Scotia",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NS",
"targetDescriptor" : "Nova Scotia",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/lBxOFiFMqryqblaq",
"maptype" : "No Change",
"sourceCode" : "NL",
"sourceDescriptor" : "Newfoundland and Labrador",
"sourceSinceVersion" : "2002.0.0",
"targetCode" : "NL",
"targetDescriptor" : "Newfoundland and Labrador",
"targetSinceVersion" : "2002.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/R52XeJK2hJY0FvFb",
"maptype" : "No Change",
"sourceCode" : "PE",
"sourceDescriptor" : "Prince Edward Island",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "PE",
"targetDescriptor" : "Prince Edward Island",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/rczeSiD0Bi5LslOv",
"maptype" : "No Change",
"sourceCode" : "BC",
"sourceDescriptor" : "British Columbia",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "BC",
"targetDescriptor" : "British Columbia",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/xzQH64AQ3MO8yobP",
"maptype" : "No Change",
"sourceCode" : "NU",
"sourceDescriptor" : "Nunavut",
"sourceSinceVersion" : "1999.0.0",
"targetCode" : "NU",
"targetDescriptor" : "Nunavut",
"targetSinceVersion" : "1999.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/KFytLKZ437SzR11p",
"maptype" : "No Change",
"sourceCode" : "NT",
"sourceDescriptor" : "Northwest Territories",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NT",
"targetDescriptor" : "Northwest Territories",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/CVuFLE9Nm0krCZ98",
"maptype" : "Update",
"sourceCode" : "YT",
"sourceDescriptor" : "Yukon Territory",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "YT",
"targetDescriptor" : "Yukon",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/XBApMvSyym0DFrcU",
"maptype" : "No Change",
"sourceCode" : "AB",
"sourceDescriptor" : "Alberta",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "AB",
"targetDescriptor" : "Alberta",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/NBEufKEmXO4g4Adm",
"maptype" : "No Change",
"sourceCode" : "ON",
"sourceDescriptor" : "Ontario",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "ON",
"targetDescriptor" : "Ontario",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/X8TSQiUFKEgvH4gJ",
"maptype" : "No Change",
"sourceCode" : "NB",
"sourceDescriptor" : "New Brunswick",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NB",
"targetDescriptor" : "New Brunswick",
"targetSinceVersion" : "1990.0.0"
} ]
}
