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

Course Widgets

Course JSON endpoints

Style	Required	Optional	Working example (click to see the JSON)
Course list, narrowed to one record	catalogId in the path	page-size, page, legacy-id, type, prefix, code, name	/widget-api/catalog/41/courses/?page-size=100&page=1&prefix=ACCT&code=211
Course detail (one record)	catalogId and internal courseId	None	/widget-api/catalog/41/course/44779/

The list call above already returns a single course (prefix + code is unique); its id field (44779) is what the detail call uses. See the full endpoint reference for the general list-then-detail pattern.

---

The Course 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, referencing content from our training sandbox.

Link Widget

This will generate a link to a specific course within a catalog, which will direct your user away from this page, and to your course in Acalog. When generating your Widget, you will need to specify a catalog filter and a course 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.

The course filter could be the course name or ID, or a combination of filters - like course prefix and course code. Similar to the catalog filter, if you use the ID, you would be refering to a single, specific version of a course - but if you refer to a prefix and code or a name, you can generate a continously updating link.

How you set up your filters will depend upon your needs for this Widget - if you are setting up something that you want to be able to update itself year to year - you will likely want to reference the catalog by type, and the course by the aspects that are least likely to change - like prefix and code. (We see a lot of name changes for courses, but every institution is different!) If you reference the course by an ID, then it can never update because you referencing a single specific instance of the course within a specific catalog year. There is no right or wrong answer here - it's entirely up to you to determine what your needs are.

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 courses 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 courses, or narrow it by a course type.

Displaying all courses will place them in alphanumerical order based on their prefix and code combination. If you would like to, you can choose to use the course filter option to narrow it to the courses within a specific course type, or those that share a specific prefix.

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 embed the contents of a course directly on your website without having directing your user to another site. If you reference it by Prefix and Code, and the course maintains that same Prefix and Code 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 courses, you're likely to have Permalink references - maybe to other courses within prerequisites or corequisites, for example. Depending on your preference, you can determine how those additional course 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 course, or if you want to direct them back to Acalog to review the additional course information.