• Start
• Builder
• Catalog
• Course
• Program
• Entity
• Filter
• Page
• Planner

Program Widgets

Program JSON endpoints

Style	Required	Optional	Working example (click to see the JSON)
Program list, found by exact name (one record)	catalogId in the path	page-size, page, legacy-id, type, degree-type, code, name	/widget-api/catalog/41/programs/?page-size=100&page=1&name=Accounting%20%28ACCT%29%20-%20BS%20Major
Program detail (one record) - step 2, using the id from the row above	catalogId and internal programId	None	/widget-api/catalog/41/program/5628/
Program list, disambiguated by code and type (one record)	catalogId in the path	code, type	/widget-api/catalog/41/programs/?page-size=100&page=1&code=ACCT&type=BS%20Major
Media detail (one record)	catalogId and internal mediaId	None	/widget-api/catalog/41/media/5054/

This is exactly the two-step call sequence major-map.js makes below: list by name to get the program id, then fetch that program's detail record (which includes the description HTML the major-map links live in). See the full endpoint reference for every family.

---

The Program Widgets 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 program within a catalog, which will direct your user away from this page, and to your program in Acalog. When generating your Widget, you will need to specify a catalog filter and a program filter.

The catalog filter could be the catalog type (such as undergraduate or graduate - or widget, as in this example), or perhaps the catalog name, or even a specific catalog ID, depending upon whether you are wanting to point to a specific course within a specific catalog at a fixed point in time, or if you are wanting an option that can continue to update itself. Referring to a catalog by an ID would result in a fixed catalog, whereas using a type would allow you to refer to a continuously updated catalog from year to year.

If you reference the program by name, and the program 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!

Major map file links

The custom helper below follows the current program's media permalinks and renders zero or more current major-map PDFs:

Multiple major maps

Music Performance currently has three maps, which are all discovered and rendered:

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 type of Widget will pull a listing of all of the programs in your catalog in the selected catalog filter (such as undergraduate, or in this example, Widget) and you can choose to let it list either all programs, or narrow it by a program type.

Displaying all programs will place them in alphanumerical order based on their names. If you would like to, you can choose to use the Progam Filter option to narrow it to Program or Degree Type.

Note:

You should keep in mind this is not the same as a filter within your catalog, so you won't have as many options - such as being able to sort them by Hierarchy ownership. For that, you may want to go ahead and pull in a Filter Widget instead!

Content Widget

This can be used to display a program directly on your website without having to click a link or be directed to another site. If you reference it by name, and the program 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!

The Content Widget also has the Dynamic option available - so if you choose to use this option for displaying program content, when enabled, the courses within the program will behave a show/hide link rather than directing users to your catalog within Acalog. It's a great option for keeping that experience seamless for your students!