Page Widgets
Page JSON endpoints
| Style | Required | Optional | Working example (click to see the JSON) |
|---|---|---|---|
| Page list | catalogId in the path |
page-size, page, legacy-id, name |
/widget-api/catalog/41/pages/?page-size=100&page=1 |
| Page list, found by name (one record) | catalogId in the path |
name |
/widget-api/catalog/41/pages/?page-size=100&page=1&name=Tuition%20%26%20Fees |
| Page detail (one record) | catalogId and internal pageId |
None | /widget-api/catalog/41/page/5343/ |
See the full endpoint reference for the general list-then-detail pattern.
The Page Widgets will pull Custom Page data and can be provided through a Link, List, or embedded directly on the page as Content. 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 custom page within a published, current catalog. (It can not be used to reference archived catalogs.) If you reference it by the custom page's name, and the custom page 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...
Note:
When you are establishing the page widget, note that you'll need to reference the Navigation Link Label as the Page Name, and not the Page Header.
List Widget
Choosing to display all of the pages within a catalog will place them in alphanumerical order based on their name - and remember, name will refer to the Navigation Link Label specifically. With pages, 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. Should your Custom Pages contain permalinks to additional content throughout your catalog, you can choose if you'd like to use the Dynamic option - this would determine if the links would direct the user to Acalog to view that additional content, or if they would stay on the current page.
Pages List
This list of pages will open as links that direct the user away from this site and over to your catalog within Acalog.
- Loading...
Pages List - Dynamic
This list of pages uses the Dynamic option which allows the link to unfurl as a show/hide option, rather than directing the user away from the site.
- Loading...
Content Widget
This can be used to embed the contents of a custom page directly on your website without having directing your user to another site. Super helpful if you want to make sure your website and Acalog stay in sync without having to duplicate data entry. If you reference it by name (remember, Navigation Link Label!), and the entity maintains that same name each year - then you won't have to update this reference even when you publish a new catalog of the same type!
In some of your custom pages, you're likely to have Permalink references - maybe to courses that are owned by the entity, for example. Depending on your preference, you can determine how those additional links should be have by using the Dynamic option to use a show/hide link to allow your users to determine if they want to review the full item, or if you want to direct them back to Acalog to review the additional information.