Reference data as a Services (RDaaS)

Produced by: Center for statistical data standards

Table of contents

Revision history
Purpose of Document
Summary
Access and availability
Technology
Definitions
Application Programming Interface (API) methods and examples:
Concordances
- Map Types

Revision history

Revision history
Date	Version	Revision details
August 16, 2024	2.2	Corrections to documentation
August 15, 2024	2.1	Add Index endpoints
July 5, 2024	2.0	Remove API key requirement New URL
June 1, 2022	1.0	First release of RDaaS User Guide

Purpose of Document

The purpose of this document is to provide users with a guide to the Reference Data as a Service (RDaaS), which has been made accessible through the Government of Canada API (Application Programming Interface) Store.

Summary

The Reference Data as a Service (RDaaS) is a list of codesets, classifications and concordances that are used within Statistics Canada and shared to help harmonise data for better interdepartmental data integration and analysis. This RDaaS initiative is meant to share Statistics Canada's reference data with everyone that would like to facilitate & harmonise data for analysis between Government of Canada and its data partners.

Access and availability

The Application Programming Interface (API) is accessible to the public. In general, the API is expected to be available 24/7 except during system updates.

The base Universal Resource Locator (URL) of the API is at:

https://api.statcan.gc.ca/rdaas

Technology

Hyper Text Transfer Protocol Secure (HTTPS) is a standard way of communicating across the Web and includes methods such as GET and POST used with the web service.

The implementation is a RESTful (built using representational state transfer [REST] architecture) web data service over HTTPS protocol, which will return data in JSON (JavaScript Object Notation) language.

REST is an architectural style that specifies constraints, such as the uniform interface, that if applied to a web service induce desirable properties, such as performance, scalability and modifiability, which enable services to work best on the Web.

Definitions

These Application Programming Interface (API) will give you full list of codesets in the language asked. Here are the classifications and codesets that are getting included and available for general consumptions: Definitions, data sources and methods (statcan.gc.ca). An example of a classification you can find is Gender where you will be able to download through this API the following information: Classification of gender (statcan.gc.ca).

Application Programming Interface (API) methods and examples:

We list numerous types of methods for the Application Programming Interface (API) here:

Search

RDaaS search functionality provides users with the ability to search for the resources they are looking for based on a variety of parameters. Each type of resource will have an endpoint where the actual search is performed, along with the potential for supplemental endpoints that can be used to retrieve user specific parameters to use in the search. These parameters may change based on the user's role.

Search classifications

Searches and filters classifications. Text searching is applied to the classification names and and descriptions. The applicable filters can be found from the get classification search filters method. This search supports paging, and a offset and limit can be specified.

Search classifications - more information

HTTP request method: GET

Relative URL: /search/classifications

Parameters:

Name: Description
limit integer (query): the number of results to return; optional, 10 by default, 500 maximum
Default value: 10
q string (query): the search text; optional, omit to search all
start integer (query): the start position for the results returned; optional, 0 (start at first result) by default
Default value: 0
audience string (query): A parameter can be repeated to filter on more than one value at a time.
Note that the values shown here may not be available to all users. See the corresponding /filters method for this to determine which filter values are applicable to you.
Available values: PUBLIC, INTERNAL, SYSTEM, IATD
status string (query): A parameter can be repeated to filter on more than one value at a time.
Note that the values shown here may not be available to all users. See the corresponding /filters method for this to determine which filter values are applicable to you.
Available values: DEFINED, VERIFIED, PENDING, APPROVED, RELEASED, WITHDRAWN, RETIRED, ARCHIVED

Response Code:

Http Status Code	Description
200	Classifications retrieved successfully.

Example:
This call will return the first 10 classifications available where you can find the id to be used in other calls.

Call:
https://api.statcan.gc.ca/rdaas/search/classifications?limit=10

Results:

{
"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
}
}
}

Classification search filters

This will return a list of filters and the values that can be used on them when searching for classifications. The can be used as query parameters on any search request. For example, if the there is a filter named "bank" with values "A", "B", and "C", query parameters can be added to any search request to filter the results based on these values. For instance, to filter on "bank" "A" and "B", one could append ?bank=A&bank=B to the query url. It is worth noting that these filers will also be included as facet counts in all search results.

Classification search filters - more information

HTTP request method: GET

Relative URL: /search/classifications/filters

Parameters:
None

Response Code:

Http Status Code	Description
200	Classifications retrieved successfully.

Example:
This call will return a list a classification filters that can be used in other calls.

Call:
https://api.statcan.gc.ca/rdaas/search/classifications/filters

Results:

[ {
"parameter" : "status",
"values" : [ "RELEASED", "RETIRED", "ARCHIVED" ]
}, {
"parameter" : "audience",
"values" : [ "STANDARDS", "NON_STANDARDIZED" ]
} ]

Search concordances

Searches and filters concordances. Text searching is applied to the concordance names and and descriptions. The applicable filters can be found from the get concordance search filters method. This search supports paging, and an offset and limit can be specified.

Search concordances - more information

HTTP request method: GET

Relative URL: /search/concordances

Parameters:

Name: Description
limit integer (query): the number of results to return; optional, 10 by default, 500 maximum
Default value: 10
q string (query): the search text; optional, omit to search all
start integer (query): the start position for the results returned; optional, 0 (start at first result) by default
Default value: 0
audience string (query): A parameter can be repeated to filter on more than one value at a time.
Note that the values shown here may not be available to all users. See the corresponding /filters method for this to determine which filter values are applicable to you.
Available values: PUBLIC, INTERNAL, SYSTEM, IATD
status string (query): A parameter can be repeated to filter on more than one value at a time.
Note that the values shown here may not be available to all users. See the corresponding /filters method for this to determine which filter values are applicable to you.
Available values: DEFINED, VERIFIED, PENDING, APPROVED, RELEASED, WITHDRAWN, RETIRED, ARCHIVED

Response Code:

Http Status Code	Description
200	Concordances retrieved successfully.

Example:
This call will return the first 10 concordances available where you can use the id for other calls.

Call:
https://api.statcan.gc.ca/rdaas/search/concordances?limit=10

Results:

{
"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
}
}
}

Concordance search filters

This will return a list of filters and the values that can be used on them when searching for concordances. The can be used as query parameters on any search request. For example, if the there is a filter named "bank" with values "A", "B", and "C", query parameters can be added to any search request to filter the results based on these values. For instance, to filter on "bank" "A" and "B", one could append ?bank=A&bank=B to the query url. It is worth noting that these filers will also be included as facet counts in all search results.

Concordance search filters - more information

HTTP request method: GET

Relative URL: /search/concordances/filters

Parameters:
None

Response Code:

Http Status Code	Description
200	Concordances retrieved successfully.

Example:
This call will return the list of filters available to be used in other calls.

Call:
https://api.statcan.gc.ca/rdaas/search/concordances/filters

Results:

[ {
"parameter" : "status",
"values" : [ "RELEASED", "RETIRED", "ARCHIVED" ]
}, {
"parameter" : "audience",
"values" : [ "STANDARDS", "NON_STANDARDIZED" ]
} ]

Classifications-codesets

Generally a statistical classification is a way to group a set of related categories in a meaningful, systematic, and standard format. The statistical classification is usually exhaustive, has mutually exclusive and well-described categories, and has either a hierarchical or a flat structure. A statistical classification usually contains codes and descriptors.

This section contains requests that provide information about classifications, their levels and codes, and changes across versions. These resources are available themselves in several different views (typically detailed and summary) along with a few utilities that are designed to provide users with answers to specific questions they may have without requiring them to dig through all the information themselves.

Codes / Categories

Codes are an alphanumeric or numeric value that is associated with a Category. Codes are organized in a classification by levels. In a flat classification there will be a single level that contains all the codes. In a hierarchical classification codes that are stored on the higher levels will be broader while those stored on the lower levels will be more specific refinements of their parents.

Classification detail

Provides detailed information about the specified classification. This includes descriptive information about the classification, version information, levels, and all codes arranged in order and hierarchically (if applicable).

Classification detail - more information

HTTP request method: GET

Relative URL: /classification/{id}

Parameters:

Name: Description
id * string (path): Identifier of the classification.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Classification retrieved successfully.

Example:
This call will return all information available for the gender classification (lQA3IRH1ER3KXwrJ).

Call:
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ

Results:

{
"@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."
} ]
}

Classification Categories

Returns all categories at all levels of the classification as a flat list. If the classification is hierarchical, the categories here will not be presented in their hierarchy.

Classification Categories - more information

HTTP request method: GET

Relative URL: /classification/{id}/categories

Parameters:

Name: Description
id * string (path): Identifier of the classification version.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Classification categories retrieved successfully.
404	Classification not found.

Example:
This call will return the gender classification (lQA3IRH1ER3KXwrJ) categories available.

Call:
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ/categories

Results:

{
"@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
} ]
}

Classification Categories detailed

Returns the most detailed categories of the classification. These are the categories without any sub-categories. In most hierarchical classifications, these will be the categories from the lowest level. However, in a ragged classification these categories may exist at any level.

Classification Categories detailed - more information

HTTP request method: GET

Relative URL: /classification/{id}/categories/detailed

Parameters:

Name: Description
id * string (path): Identifier of the classification.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Classification categories retrieved successfully.
404	Classification not found.

Example:
This call will return the gender classification (lQA3IRH1ER3KXwrJ) categories details available.

Call:
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ/categories/detailed

Results:

{
"@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
} ]
}

Indices

Index entries are formal definitions and further refinements of categories that fall under a particular code. These are not defined as codes in a classification, but are more informational to specify which terms are included in a particular code that is defined. They can also specify codes as explicit exclusions, indicating that they should not be considered as a value related to that code. This information can be used to help users determine what code their specific category falls under.

All Indices

Returns the details of all index entries for a classification as an array called @graph. An empty @graph array means the classification was found, but the classification does not have any indices.

All Indices - more information

HTTP request method: GET

URL: /api/classification/{id}/indexes

Parameters:

Name	Mandatory	Data Type	Parameter Type (path/query)	Description
id	Yes	string	path	Identifier of the classification.

Response Code:

Http Status Code	Description
200	Index entries retrieved successfully.
404	Classification not found.

Example:
This call will return the details of all the index entries for a classification with id=owrgkARZ8Omww7qX.

Call:
https://api.statcan.gc.ca/rdaas/classification/owrgkARZ8Omww7qX/indexes

Results:

{
  "@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"
    }
  ]
}

Single Index

Returns an index entry for a classification by its index id. If the body of the request returns 1 (instead of JSON), this could mean the classification does not have any indices.

Single Index - more information

HTTP request method: GET

URL: /api/classification/{id}/indexes

Parameters:

Name	Mandatory	Data Type	Parameter Type (path/query)	Description
id	Yes	string	path	Identifier of the classification.
indexId	Yes	integer	path	Index id of the index entry.

Response Code:

Http Status Code	Description
200	Index entry retrieved successfully.
404	Classification or index entry not found.

Example:
Returns an index entry for a classification with id=owrgkARZ8Omww7qX and indexId=7.

Call:
https://api.statcan.gc.ca/rdaas/classification/owrgkARZ8Omww7qX/indexes/entry/7

Results:

{
  "@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

A Concordance is a correspondence table the formally expressed the relationships between subsequent version of variants of Classifications. It can exists between two versions of the same Classification, or across two different Classifications The relationships show how the items of the target relate to the items of the source.

A Concordance holds the collection of Maps between Codes of the source and target Classification. Several different types of Maps exist, from simple one to one correspondences to complex many-to-many relationships, complex mappings primarily exists across different versions of a Classifications.

Map Types

Different types of changes or Maps exist. The following definitions describe the types of maps that are possible in Ariā:

Deletion (1:0) - an existing Code expires
Creation (0:1) - a new Code comes into existence
Combinations (N:1)
Merger: two or more Codes expires, while their denotations proceed in one emerging Code
Take-over: a Code expires, while its denotation proceeds as part of the denotation of another item, which continues its existence
Decomposition (1:N)
Breakdown: a Code expires, while its denotation is distributed over and proceeds in two or more emerging items
Split-off: an Code continues to exist, while part of its denotation moves to another (emerging) Code
Transfer (M:N)
Simple
- Code Change (1:0, 0:1) - A Code expires, while its denotation proceeds as the denotation of en emerging item
- Property Change (1:1) - The name or other properties of a Code changes, while its denotation remains the same
- No Change (1:1) - No change takes place

Concordance detail.

Provides detailed information about the specified concordance. This includes descriptive information about the concordance, version information, and its code maps.

Concordance detail - more information

HTTP request method: GET

Relative URL: /concordance/{id}

Parameters:

Name: Description
id * string (path): Identifier of the concordance.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Concordance retrieved successfully.
404	Concordance not found.

Example:
This call will return the concordance detail for Reference data standard on Canadian provinces and territories V2002.0.0 to V2002.0.1 (s9aLOlj8BB6DplVz).

Call:
https://api.statcan.gc.ca/rdaas/concordance/s9aLOlj8BB6DplVz

Results:

{
"@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"
} ]
}

Code maps.

Returns the code maps for the specified concordance. This will not provide any additional information about the concordance. If users desire the complete detail of the concordance they can call api/concordance/{id} or if they want summary information they can call api/concordance/{id}/summary.

Code maps - more information

HTTP request method: GET

Relative URL: /concordance/{id}/maps

Parameters:

Name: Description
id * string (path): Identifier of the concordance.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Concordance maps retrieved successfully.
404	Concordance not found.

Example:
This call will return the concordance detail maps for Reference data standard on Canadian provinces and territories V2002.0.0 to V2002.0.1 (s9aLOlj8BB6DplVz).

Call:
https://api.statcan.gc.ca/rdaas/concordance/s9aLOlj8BB6DplVz/maps

Results:

{
"@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"
} ]
}

Language selection

WxT Language switcher

Search and menus

WxT Search form

Reference data as a Services (RDaaS) - API User Guide

Revision history

Purpose of Document

Summary

Access and availability

Technology

Definitions

Application Programming Interface (API) methods and examples:

Search

Search concordances

Classifications-codesets

Codes / Categories

Indices

Concordances

Map Types