https://learn.microsoft.com/api/catalog type filtering issue

Question

https://learn.microsoft.com/api/catalog type filtering issue

Grzegorz Orda 66

It seems that the filters on the endpoint behave in a strange way - depending on the order of filtering the user gets the answer correct or with errors.

Changing position of module in type filter

example of good response:

https://learn.microsoft.com/api/catalog?locale=fr-BE&type=roles,modules,products,levels,learningPaths
User's image

example of using filtering with corrupted json in response:

https://learn.microsoft.com/api/catalog?locale=fr-BE&type=modules,roles,products,levels,learningPaths

User's image

The error occurs for different languages as well as downloadable items.

Is there any way to make it work stably where this strange behavior can be sent for verification?

Unfortunately, I do not find the right tag to properly attribute this error. please move to the appropriate section.

Grzegorz Orda 66 Reputation points

2023-05-08T13:57:36.2766667+00:00

Downloading json files with a browser or Postman, the problem does not occur.

Accepted answer

1 additional answer

Your answer

Grzegorz Orda 66 Reputation points

2023-05-08T13:57:36.2766667+00:00

Downloading json files with a browser or Postman, the problem does not occur.

Answer 1

Antonio 250 Microsoft External Staff

Hi Grzegorz Orda,

Thanks for posting in the Q&A forum.

As mentioned, downloading the list via PowerShell creates a list that is exactly the same regardless of the order. (See below)

Invoke-RestMethod -Uri "https://learn.microsoft.com/api/catalog?locale=en-US&type=roles,modules,products,levels,learningPaths" -OutFile test1.txt Invoke-RestMethod -Uri "https://learn.microsoft.com/api/catalog?locale=en-US&type=modules,roles,products,levels,learningPaths" -OutFile test2.txt compare-object $(Get-Content test1.txt) $(Get-content test2.txt)

As such, create a file from the Uri and read the file to populate variable list in ASP.NET code.

Otherwise, if still occurring it could be an issue with the parser (JsonConvert.DeserializeObject) for non-English languages.

Please post feedback in the SDK issues for .NET or GitHub Opensource Creator

Please don't forget to upvote and Accept as answer if the reply is helpful

Grzegorz Orda 66

Hi,

Unfortunately, the problem still occurs for certain languages.

I wrote the code by the way described to you and the specifications - that is, using WebClient (which is obsolete) and also gets the error.

User's image

code throws an error on this request:

https://learn.microsoft.com/api/learn/catalog?locale=nl-BE&&type=learningPaths,modules

User's image

In the browser or Postman everything is ok.

Perhaps there is a bug that causes not the whole request to be parsed and released at some point - but I have not been able to find what could be causing this.

It seems that it is impossible to use HttpClient/WebClient because something causes a download error and an incomplete file is received in response

Also tested on the library (HttpClient based)- but the effect is the same for some languages an error is thrown:

https://github.com/markjulmar/MSLearnCatalogAPI/blob/main/src/CatalogApi.cs

Tested asynchronous as well as non-asynchronous code.

WebClient code as reference:


var locales = new List<string>
        {
            "ar-SA", "bg-BG", "bs-cyrl-BA", "bs-latn-BA", "ca-ES", "cs-CZ", "da-DK",
            "de-AT", "de-CH", "de-DE", "el-GR", "en-AU", "en-CA", "en-GB", "en-IE", "en-IN", "en-MY",
            "en-NZ", "en-SG", "en-US", "en-ZA", "es-ES", "es-MX", "et-EE", "eu-ES", "fi-FI", "fil-PH",
            "fr-BE", "fr-CA", "fr-CH", "fr-FR", "ga-IE", "gl-ES", "he-IL", "hi-IN", "hr-HR", "hu-HU",
            "id-ID", "is-IS", "it-CH", "it-IT", "ja-JP", "kk-KZ", "ko-KR", "lb-LU", "lt-LT", "lv-LV",
            "ms-MY", "mt-MT", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU",
            "sk-SK", "sl-SI", "sr-cyrl-RS", "sr-latn-RS", "th-TH", "tr-TR", "uk-UA", "vi-VN", "zh-CN",
            "zh-HK", "zh-TW"
        };

        foreach (var locale in locales)
        {
            Console.WriteLine(locale);
            var msLearnBaseAddress = "https://learn.microsoft.com/";
            var baseMsLearnApiAddress = "api/catalog?locale=";
            var corruptedApiAddressScope = "&type=learningPaths,modules";

            try
            {
                var addressWithLocale = msLearnBaseAddress + baseMsLearnApiAddress + locale + corruptedApiAddressScope;

                var client = new WebClient();
                client.Headers.Add(HttpRequestHeader.UserAgent, "Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko");
                var response = client.DownloadString(addressWithLocale);
                dynamic parsedJson = JsonConvert.DeserializeObject(response);
                JsonConvert.SerializeObject(response, Formatting.Indented);
                var reeee = Convert.ToString(response);

            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }

Antonio 250 Reputation points Microsoft External Staff

2023-05-15T20:43:10.05+00:00

Thanks for the reply. Please see the update to the post above for further support avenues.

Please don't forget to upvote and Accept as answer if the reply is helpful

Answer 2

Grzegorz Orda 66

Discussion moved to https://github.com/dotnet/sdk/issues/32548

Antonio 250 Reputation points Microsoft External Staff

2023-05-16T11:28:52.16+00:00

Thanks for posting in the Q&A forum.

If I have time, I'll can keep an eye on this (in GitHub) for a bit in case any further aid is needed.
Antonio 250 Reputation points Microsoft External Staff

2023-05-16T14:18:46.64+00:00
Thanks for creating a post in GitHub community as they can have further insights into this related to the SDK coding or related workarounds to get this to work.

As an update, created a PowerShell script to see which if the non-English languages not returning the same sort values.
(See PS code in GitHub post if interested)
So, it turns out that sometimes the locale languages es-ES as an example (although it can be different in some runs) for the sort order roles,modules,products,levels,learningPaths & modules,roles,products,levels,learningPaths is in fact different.

sort order "roles,modules,products,levels,learningPaths"** "type":"module","title":"Implementación de un módulo precompilado en el dispositivo perimetral","duration_in_minutes":56,"rating":{"count":890,"average":4.58},"popularity":0.460448932003016,"icon_url":"https://learn.micro "modules,roles,products,levels,learningPaths"** "type":"module","title":"Implementación de un módulo precompilado en el dispositivo perimetral","duration_in_minutes":56,"rating":{"count":890,"average":4.58},"popularity":0.460448932003016,"icon_url":https://learn.microsoft.com/es-es/training/achievements/student-evangelism/deploy-pre-built-module-iot-edge.svg...

So, the recommendation (at this time) is to use the sort order "modules,roles,products,levels,learningPaths" then the fields in the order you want to use them.
You can also create another Q&A post with learn channel tags.
Or see if training support can aid to get a list Training Support

Share via

https://learn.microsoft.com/api/catalog type filtering issue

1 additional answer

Your answer