Data Dictionary

GET https://public.richdataservices.com/rds/api/catalog/ca/pumf_icc_mh_2020/variables

This request returns the data dictionary for the data product. The data dictionary is a simple listing of all the variables that make up the data product. This should include descriptive properties of each variable including its name, label, description, question text (if captured as part of a survey / questionnare) and any associated classification references. This is not meant to provide a detailed view of any particular variable, but a general overview of the variables that are available as part of the product.

RESPONSES

status: OK

[{"dataType":"NUMERIC","id":"PUMFID","index":1,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"label":"Public use microdata file identifier","name":"PUMFID","storageType":"INTEGER","uri":"fbba8340-be4a-4250-9dd6-d6d3e1cfbcc9"},{"classificationId":"VERDATE","classificationUri":"f70fd1be-a14a-4122-b004-1a6f461fd269","dataType":"TEXT","id":"VERDATE","index":2,"isDimension":true,"isMeasure":false,"isRequired":false,"isWeight":false,"label":"Version date of when the file was created","name":"VERDATE","storageType":"VARCHAR","uri":"db86e9ed-7c5a-4b1c-a070-f46e93730319"},{"dataType":"INTEGER","id":"MH_05","index":3,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_05","storageType":"INTEGER","uri":"58ce1411-35b7-4ce3-81db-d19a6624c519"},{"dataType":"INTEGER","id":"MH_10","index":4,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_10","storageType":"INTEGER","uri":"9d4c4993-6010-46fa-bb54-018aaf688404"},{"dataType":"INTEGER","id":"MH_15A","index":5,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_15A","storageType":"INTEGER","uri":"03b0ee24-351f-4dab-b830-57eeaf4719e4"},{"dataType":"INTEGER","id":"MH_15B","index":6,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_15B","storageType":"INTEGER","uri":"1e2957d5-c5c9-451c-9f11-d380461a8593"},{"dataType":"INTEGER","id":"MH_15C","index":7,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_15C","storageType":"INTEGER","uri":"386cbf24-4a6e-4238-b2d8-df95d1501a6c"},{"dataType":"INTEGER","id":"MH_15D","index":8,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_15D","storageType":"INTEGER","uri":"07f39f50-0b75-455b-9b5f-59eaa66c3a4c"},{"dataType":"INTEGER","id":"MH_15E","index":9,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_15E","storageType":"INTEGER","uri":"4416193e-2f8e-49aa-9b04-8aaa6d6c2ec6"},{"dataType":"INTEGER","id":"MH_15F","index":10,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_15F","storageType":"INTEGER","uri":"afeaaaed-cd16-4762-b486-ca068f547d9c"},{"dataType":"INTEGER","id":"MH_15G","index":11,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_15G","storageType":"INTEGER","uri":"c251b494-8ad3-4ace-809a-87e703b2d023"},{"dataType":"INTEGER","id":"MH_20","index":12,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MH_20","storageType":"INTEGER","uri":"1826a57f-962e-422f-99cd-d9799be68cc5"},{"dataType":"INTEGER","id":"BH_60A","index":13,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_60A","storageType":"INTEGER","uri":"b110ce02-4edc-4652-a1ac-2a572ae047f5"},{"dataType":"INTEGER","id":"BH_60B","index":14,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_60B","storageType":"INTEGER","uri":"66ea5de7-6627-4a48-a2d2-f33619202602"},{"dataType":"INTEGER","id":"BH_60C","index":15,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_60C","storageType":"INTEGER","uri":"c82b3824-cb22-489b-ba1c-5b2318f90f3f"},{"dataType":"INTEGER","id":"BH_55A","index":16,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55A","storageType":"INTEGER","uri":"22a60079-395e-4f6a-af00-4653e5d06514"},{"dataType":"INTEGER","id":"BH_55B","index":17,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55B","storageType":"INTEGER","uri":"c8979a5b-1577-425e-a193-8e40a7fad347"},{"dataType":"INTEGER","id":"BH_55C","index":18,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55C","storageType":"INTEGER","uri":"aecadd9c-64dc-4f25-aaa6-58ab562b6beb"},{"dataType":"INTEGER","id":"BH_55D","index":19,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55D","storageType":"INTEGER","uri":"49e04940-e22a-41ec-aef9-50e50c1ddfbd"},{"dataType":"INTEGER","id":"BH_55E","index":20,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55E","storageType":"INTEGER","uri":"d9389392-25ed-45ef-b963-b585544800bc"},{"dataType":"INTEGER","id":"BH_55F","index":21,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55F","storageType":"INTEGER","uri":"167194e0-7c51-4043-b7c2-90b9767acbd6"},{"dataType":"INTEGER","id":"BH_55G","index":22,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55G","storageType":"INTEGER","uri":"5acef8fd-2ba5-4485-aefa-bd0398331e1b"},{"dataType":"INTEGER","id":"BH_55H","index":23,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55H","storageType":"INTEGER","uri":"46e62984-c966-49b6-90be-c6509d7d697c"},{"dataType":"INTEGER","id":"BH_55I","index":24,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55I","storageType":"INTEGER","uri":"2087c428-1c89-4f3f-97e6-5d6f8d85aa82"},{"dataType":"INTEGER","id":"BH_55J","index":25,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55J","storageType":"INTEGER","uri":"27cd5c35-b8e0-4e08-ac2f-ca7ed4fd31bb"},{"dataType":"INTEGER","id":"BH_55K","index":26,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"BH_55K","storageType":"INTEGER","uri":"59a16b4b-ee4e-4fc8-be15-a1e97b05c0fe"},{"classificationId":"DEM_10","classificationUri":"e6f66055-aa33-4baa-b513-b4681f4ee49b","dataType":"NUMERIC","id":"DEM_10","index":27,"isDimension":true,"isMeasure":false,"isRequired":false,"isWeight":false,"label":"Gender benchmarked to sex","name":"DEM_10","questionText":"What is your gender?","storageType":"INTEGER","uri":"0d6b4dcb-cc8d-4b6d-898f-d4d4da756786"},{"dataType":"INTEGER","id":"MHDVMHI","index":28,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"MHDVMHI","storageType":"INTEGER","uri":"560364f3-b328-4e7f-ad85-baad13b6b04f"},{"dataType":"INTEGER","id":"ANXDVGAD","index":29,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"ANXDVGAD","storageType":"INTEGER","uri":"8759ea6e-40f3-491f-b126-e044ec3cc116"},{"dataType":"INTEGER","id":"ANXDVGAC","index":30,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"ANXDVGAC","storageType":"INTEGER","uri":"e61fe64e-aa25-4192-bd10-3c5c9dcf2e31"},{"dataType":"INTEGER","id":"ANXDVSEV","index":31,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"ANXDVSEV","storageType":"INTEGER","uri":"2fa4cf71-c429-4395-bb92-e4be21846524"},{"dataType":"INTEGER","id":"AGEGR_10","index":32,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"AGEGR_10","storageType":"INTEGER","uri":"1fdcd8a1-4539-4f71-a3da-840d79c2353c"},{"dataType":"INTEGER","id":"PBH_55L","index":33,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"PBH_55L","storageType":"INTEGER","uri":"e5361265-4383-471c-afc1-f64159043fdf"},{"dataType":"INTEGER","id":"PCSIZMIZ","index":34,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"PCSIZMIZ","storageType":"INTEGER","uri":"c728a407-acbe-41cc-bf0e-131ae4124fea"},{"classificationId":"PIIDFLAG","classificationUri":"d79bf976-1617-4497-b7b4-8f79b14f55f4","dataType":"NUMERIC","id":"PIIDFLAG","index":35,"isDimension":true,"isMeasure":false,"isRequired":false,"isWeight":false,"label":"Indigenous identity flag","name":"PIIDFLAG","storageType":"INTEGER","uri":"547464b9-d3bc-4cb3-875c-85512b763f65"},{"classificationId":"PIMMST","classificationUri":"7383071f-41ac-4757-aca1-d4159d5d9d7d","dataType":"NUMERIC","id":"PIMMST","index":36,"isDimension":true,"isMeasure":false,"isRequired":false,"isWeight":false,"label":"Immigration status","name":"PIMMST","storageType":"INTEGER","uri":"2577136b-5282-43ea-ac3f-69b25f1d9fc8"},{"dataType":"INTEGER","id":"PLM_30","index":37,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"PLM_30","storageType":"INTEGER","uri":"703abbbe-69f7-45a4-8dc9-536d4c9abe63"},{"dataType":"INTEGER","id":"PLM_40","index":38,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"PLM_40","storageType":"INTEGER","uri":"cda51c74-6b94-490b-b2b4-60f8b88849cf"},{"classificationId":"PPROV","classificationUri":"22cbbfb0-d825-4584-8b88-1efefb6c8c7b","dataType":"NUMERIC","id":"PPROV","index":39,"isDimension":true,"isMeasure":false,"isRequired":false,"isWeight":false,"label":"Province of residence","name":"PPROV","storageType":"VARCHAR","uri":"f49799df-637d-4e19-b9ca-04bd1b6ed132"},{"dataType":"TEXT","id":"PRURURB","index":40,"isDimension":false,"isMeasure":false,"isRequired":false,"isWeight":false,"name":"PRURURB","storageType":"VARCHAR","uri":"6acef634-45f1-4113-8273-e892fe6680cf"},{"classificationId":"PVISMIN","classificationUri":"bdc74c5f-e19d-4532-8997-0e3e34e755a7","dataType":"NUMERIC","id":"PVISMIN","index":41,"isDimension":true,"isMeasure":false,"isRequired":false,"isWeight":false,"label":"Visible minority","name":"PVISMIN","storageType":"INTEGER","uri":"703ce465-90d3-49ae-9a08-df000a136aac"},{"dataType":"INTEGER","id":"PAGEGR","index":42,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":false,"name":"PAGEGR","storageType":"INTEGER","uri":"d8dd8fbf-fb96-4887-bd20-b5de223f29c3"},{"dataType":"NUMERIC","id":"PUMFFACT","index":43,"isDimension":false,"isMeasure":true,"isRequired":false,"isWeight":true,"label":"Factor to benchmark survey to population totals, stand to num particip","name":"PUMFFACT","storageType":"DOUBLE_PRECISION","uri":"559fa979-311c-4181-bd21-9762c1182091"}]