API Guide - Program Web Info

The API for Program Web Info provides a programmatic way for external sources, such as your college's main website, to fetch program summary data from Northstar for inclusion on the website. Integrating the Program API into your website typically involves coordinating with the web developer maintaining your site to develop the custom code and integration.

In Northstar, the "[E] - Program Web Info (webAPI)" report is the exact source for the API data and offers a quick overview of the results in an Excel-based format.

screenshot of the 'Program Web Info' report in the Northstar desktop application

Accessing the API

The Web UI page listed below can be used to explore and test the API data before integrating it into your site.

Note: replace "COLLEGE" in the following URLs with your own specific domain.

Testing Site

  • Web UI: https://portal.COLLEGE.edu/Test/apidocs
    • Click 'Beta' to expand the Programs options

Production Site:

  • Web UI: https://portal.COLLEGE.edu/Portal/apidocs
    • Click 'v1' to expand the Programs options

Exploring the API

On the Web UI page, you can enter a Catalog Year for the 'id' parameter to load all of the program summaries for that year.

screenshot of Web UI for Program Web Info API

  • Format: JSON
  • Parameters:
    • Program Outcome Catalog Year (eg. 2024, 2025)
  • Results:
    • a list of summary details of COE programs within that year
Result Detail
ProgramKey
ProgramOutcomeKey
ProgramName
ProgramYear
RequiredHours
ProgramOutcomeCluster
RegistrationFee
EstimatedTuition
EstimatedFee
EstimatedMaterielUsedCost
EstimatedMaterialRetailCost
HighSchoolStudentCost
ScholarshipEligible
VAEligible
TitleIVEligible
AvailableToAdult
AvailableToSecondary
ProgramLength
ProgramAdvisors
Location
AverageAnnualJobs
PlacementRate
AverageLowWage
MedianWage
AverageHighWage
WageType
WageInformationSource
ProgramDescription
GainfulEmploymentDisclosuresURL
AdmissionRequirementsDescription
EnrollmentDescription
SkillsAndConceptsDescription
FacilitiesDescription
EquipmentDescription
ClassRoomAvailability
AlternativeProgramCost
RequiredCredits
EstimatedTuitionCredits
ProgramCIPCode

Note: It is not recommended to call the API directly from the website on every page load. If possible, results should be cached and refreshed daily. This will make the integration faster and more resilient to changes to Northstar or the connection that could disrupt your main site.

Change History

  • 2024-12-09 (v2.24.12.0)
    • Added ProgramCIPCode to results