Aller au contenu principal

Selection des filtres

Cette section montre comment utiliser les filtres pour les requêtes API. L'ajout d'un filtre se fait en deux étapes. La première étape consiste à sélectionner le paramètre qui donnera à l’API le niveau d’agrégation requis, et la seconde consiste à appliquer le filtre. Assurez-vous de faire une requête POST, et non GET.

Ajout d'un seul filtre​

Le point de terminaison et la chaîne de requête pour obtenir le nombre d'offres d'emploi en juillet 2022 au niveau d'une division de recensement sont les suivants :

https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=14&start=20220701&end=20220701&geo=census_division

Cette requête renverra le nombre de postes affichés pour chaque région de recensement. Si l’utilisateur veut obtenir seulement certaines régions de recensement, il doit utiliser un filtre.

Accédez au corps de votre requête et saisissez ce qui suit :

{"census_division":["Greater Vancouver"]}

Pour filtrer pour une autre région, utilisez le format suivant :

{"census_division":["Greater Vancouver","Baffin"]}

Aperçu de la requête et de la réponse​

La requête de filtrage de l'API pour le Grand Vancouver et Baffin ressemble à ceci :

curl --location --request POST 'https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=14&start=20220701&end=20220701&geo=census_division' \
--header 'x-api-key: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{"census_division":["Greater Vancouver","Baffin"]}'

Assurez-vous que l’en-tête « Content-Type : application/json » est ajouté pour toutes les requêtes afin que l’API lise le corps JSON où se trouve le filtre dans la requête.

La réponse :

{
    "data": [
        {
            "source": "Vicinity Jobs",
            "ref_date": "2022-07-31",
            "data_frequency": "monthly",
            "noc_code": "",
            "noc_level": null,
            "noc_title_en": "",
            "country": "Canada",
            "provinces_territories": "BC",
            "economic_regions_en": "Mainland/Southwest",
            "census_division": "Greater Vancouver",
            "location": null,
            "indicator_name_en": "Job postings count",
            "indicator_value": 29152
        },
        {
            "source": "Vicinity Jobs",
            "ref_date": "2022-07-31",
            "data_frequency": "monthly",
            "noc_code": "",
            "noc_level": null,
            "noc_title_en": "",
            "country": "Canada",
            "provinces_territories": "NU",
            "economic_regions_en": "Nunavut",
            "census_division": "Baffin",
            "location": null,
            "indicator_name_en": "Job postings count",
            "indicator_value": 310
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "per_page": 1000,
        "total_rows": 2
    }
}

Ajout de plusieurs filtres​

Dans la continuité de l'exemple précédent, ajoutez un autre filtre en suivant la notation ci-dessous :

{"census_division":["Greater Vancouver","Baffin"],"noc":["1"]}

Avant d’envoyer cette requête API, assurez-vous que le paramètre noc_level=1 est spécifié afin que l’API puisse agréger la réponse par noc ainsi que census_divison. noc_level=1 spécifie le niveau professionnel le plus large et "noc" :["1"] spécifie la catégorie professionnelle « Professions liées aux affaires, à la finances et à l'administration ».

Aperçu de la requête et de la réponse​

Le filtrage de la requête API pour le Grand Vancouver et Baffin pour la CNP 1 ressemble à ceci :

curl --location --request POST 'https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=14&start=20220701&end=20220701&geo=census_division&noc_level=1' \
--header 'x-api-key: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{"census_division":["Greater Vancouver","Baffin"],"noc":["1"]}'

La réponse de l’API :

    {
        "data": [
            {
                "source": "Vicinity Jobs",
                "ref_date": "2022-07-31",
                "data_frequency": "monthly",
                "noc_code": "1",
                "noc_level": 1,
                "noc_title_en": "Business, finance and administration occupations",
                "country": "Canada",
                "provinces_territories": "BC",
                "economic_regions_en": "Mainland/Southwest",
                "census_division": "Greater Vancouver",
                "location": null,
                "indicator_name_en": "Job postings count",
                "indicator_value": 5380
            },
            {
                "source": "Vicinity Jobs",
                "ref_date": "2022-07-31",
                "data_frequency": "monthly",
                "noc_code": "1",
                "noc_level": 1,
                "noc_title_en": "Business, finance and administration occupations",
                "country": "Canada",
                "provinces_territories": "NU",
                "economic_regions_en": "Nunavut",
                "census_division": "Baffin",
                "location": null,
                "indicator_name_en": "Job postings count",
                "indicator_value": 50
            }
        ],
        "meta": {
            "current_page": 1,
            "total_pages": 1,
            "per_page": 1000,
            "total_rows": 2
        }
    }