WidgetAPI

Review usage of the Widget API

Catalog Widgets

Catalog JSON endpoint

Catalog widgets use GET https://catalog.winona.edu/widget-api/catalogs/. No path parameter is required. Optional query parameters are page-size, page, legacy-id, type, and name.

Working example (click to see the JSON): /widget-api/catalogs/?page-size=100&page=1&type=Undergraduate

One record, no detail route exists for catalogs - narrow the list with an exact legacy-id instead: /widget-api/catalogs/?page-size=100&page=1&legacy-id=41

See the full endpoint reference for the general list-then-detail lookup pattern used across every family.

---

The Catalog Widgets can be provided through a Link or a List. This page will provide an explanation and example of each one, pulling the content from our training sandbox.

Link Widget

This will generate a single link to a published catalog based on the options you choose in your catalog filter. If you are looking for a way to have a link that updates automatically each year when you pubish your new catalog - this is the option you are looking for!

This can only reference published catalogs (NOT archived), and its a good idea to reference catalogs by type to allow it to update automatically - referencing by ID will provide a static link instead. You can use it to create a link to multiple catalogs if you have several types - such as an undergraduate and a graduate catalog, but you would need to create a seperate link for EACH type.

Tip:

The sandbox is going to generate a standard link URL, which will replace the current window, directing them away from this site and back to your catalog on Acalog. To return to this page, they would then need to use their browser back button. You can adjust the target of the URL by adding in the target="blank" HTML tag into your Widget code, to allow it to open in a new window/tab instead!

List Widget

This will generate a list of all published catalogs - or you could specify by type - including any past versions that are now archived.

In the two columns below are examples of two lists generated from the same Publisher - one for catalogs with an Undergraduate type, and another for those sharing a Graduate type. These lists display all of the currently published catalogs sharing the same type - inclusive of the archived catalogs. If new catalogs are published with the same type, they would be automatically included within the list.

When you are referencing a catalog by type, make sure that you use the correct spelling, spacing and capitlization or it won't return anything! Undergraduate is not the same as undergraduate or under graduate to the Widget!

Note:

The sandbox is going to generate a list in this case, not a link to insert - so you won't be able to just edit the code with the additional target code to change how the URL will open.