Setup API Integrations with Classic Kuali Student

Kuali rest APIs allows you to connect to external data sources including other Classic Kuali products like Kuali Student. This article goes over how to set up these integrations with some examples to get you started.

• Kuali Student API Resources
• Some Examples of Kuali Student Integrations
• Getting Courses, Programs, Experiences, or Specializations
• Getting a List of Subject Codes

Kuali Student API Resources

The APIs available for Kuali Student are documented within the CM and Catalog tabs of https://developers.kuali.co. This guide also goes over how to get the necessary API key required for authentication with Kuali Student in the General section.

Some Examples of Kuali Student Integrations

All of these requests are GET requests, and will look similar to the example shown below when you set up the integration in Kuali (with your specific URL/API key and appropriate Path to Results Array, ID Key, Label Key, Outputs, etc). This example is pulling a list of active courses with a query configured so the dropdown is searchable and limited to 100 results:

https://{domain}.kuali.co/api/cm/courses/queryAll?status=active&limit=100

The resulting lookup will appear like this when running a test or adding to the form:

Once the integration has been created, you can add it to the Kuali form via the Advanced gadget of Data Lookup (List) and point the data source to the newly created integration:

You can also make use of the linked auto-filled gadgets on the form so that when a user provides the course to look up, it will display the associated data on the form.

Here are a few more examples of commonly used API calls to pull information from Classic Kuali Student into Kuali Platform. Hopefully these examples can help you get started and expand on other integrations you may want to set up, but if you have questions or would like to see additional examples - let us know! 

Getting Courses, Programs, Experiences, or Specializations

You can use the API end points noted here in the documentation to query either courses, programs, experiences, or specializations from Kuali Student with filters as desired:

https://developers.kuali.co/#cm-courses,-programs,-experiences,-and-specializations-query-get

For example, if you wanted to create a dropdown field in a form to lookup a list of all active programs, you could use a request like this example in the integration:

/api/cm/programs/queryAll?status=active

You can swap out the bolded text (programs) in this request with courses, experiences, or specializations depending on the area in Student you want to query.

Note: The item payloads will return only a Kuali ID as the value for any fields that use an option type or reference a group. This is not typically a human-friendly format and may appear as a string of numbers. You can look up the items by their ID to determine their label or human-friendly value with requests such as these:

• /api/cm/options/{id} to look up the value of an option type
• /api/v1/groups/{id} to loop up the value of any group fields

Getting a List of Subject Codes

If you wanted to retrieve a list of all Subject Codes, you can use the end point described here: https://developers.kuali.co/#cm-options-option-type-get.

For example, if you want to get a list of the subject codes housed within the option types, you would use the following URL in the integration:

/api/cm/options/types/subjectcodes

This will return the details of the items housed as subject codes, formatted in JSON. Here is an example of how that data may look:

{
    "name": "ACCT",
    "type": "subjectcodes",
    "active": true,
    "locale": "en-US",
    "createdAt": "2024-02-23T19:50:59.119Z",
    "updatedAt": "2024-02-27T21:21:55.209Z",
    "additionalDescriptions": null,
    "description": "Accounting",
    "linkedGroup": "65d8f9cf47a697001f7e0d09",
    "id": "65d8f723718efa3ac36e9f87"
  }