Filter Widgets
Filter JSON endpoints
| Style | Required | Optional | Working example (click to see the JSON) |
|---|---|---|---|
| Filter list | catalogId in the path |
page-size, page, legacy-id, name |
/widget-api/catalog/41/filters/?page-size=100&page=1 |
| Filter list, found by name (one record) | catalogId in the path |
name |
/widget-api/catalog/41/filters/?page-size=100&page=1&name=Course%20Descriptions |
| Filter detail (one record) | catalogId and internal filterId |
None | /widget-api/catalog/41/filter/5344/ |
See the full endpoint reference for the general list-then-detail pattern.
The Filter Widgets can be provided through a Link or List. This page will provide an explanation and example of each one, pulling content from our training sandbox.
Link Widget
This will generate a link to a specific filter within a published, current catalog. (It can not be used to reference archived catalogs.) This can be helpful if you want to display other content, like programs or courses, in an organization beyond alphanumeric. If you reference it by the filter's name, and the filter maintains that same name each year - then you won't have to update this link even when you publish a new catalog of the same type!
Example: Loading...
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
Choosing to display all of the filters will place them in alphanumerical order based on their name. With filters, you won't have a lot of options for narrowing them down other than using the catalog filter to indicate which catalog you are pulling from.
- Loading...
Note:
You might have noticed that when you were working with the sandbox, the dynamic options seems to be available for filters when creating a list Widget. Unfortunately, it's not ready just yet - so if you try to use the option, the code will generate, but you'll still only be provided with the clickable link rather than the full show/hide. Here is an example:
- Loading...