Planner Widgets
Planner JSON endpoint
The planner widget uses the program list endpoint to find programs, then the same program detail endpoint documented on the Program page to render the planner content. Required path parameter: catalogId. Optional filters are page-size, page, legacy-id, type, degree-type, code, and name.
Working example, narrowed to one record by exact name (click to see the JSON): /widget-api/catalog/41/programs/?page-size=100&page=1&name=Accounting%20%28ACCT%29%20-%20BS%20Major
See the full endpoint reference for the general list-then-detail pattern.
The Planner Widgets will pull information from the degree planners can be provided through a Link or a 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 program's degree planner within a published, current catalog. (It can not be used to reference archived catalogs.) If you reference it by the program's 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!
Example: Loading...
List Widget
This can generate a list of links to the degree planners of all 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.
- Loading...