Embedded Files
The common good APIs listed provide access to frequently used and requested data sets to support integrations with UMN systems. Most APIs listed are sourced directly from the Common Data Layer (CDL), which is populated from the originating sources of data. At a minimum, the CDL is updated once daily from these sources such as PeopleSoft HRMS, PeopleSoft Student, and Oracle Identity Management. The data latency of each API is indicated by each API’s description, and varies from “near real time” of 10 minutes, up to 24 hours.
Some APIs are classified as ‘public’, meaning they utilize public data and are generally available to use for system integrations with minimal approval required. APIs classified as ‘private-restricted’ or 'highly-restricted' contain data that are restricted; usage of these APIs requires process review and approval from data custodians.
If a common good API listed would meet the business requirements for a system integration, visit the Get Access to Common Good APIs page to learn more about the process to request and ultimately use an API. If a common good API listed does not meet the system integrations need, visit the Custom Integrations Solutions page to request support from the University’s OIT Integration team.
List of Common Good APIs
List of Common Good APIs
Data Classification: Public
Data Currency: less than 24-hours behind the transactional data source (nightly reconciliation update)
This API Service provides affiliation information for students enrolled in the current term by primary campus.
activeEmployees
This endpoint will provide a list of active employees at the University of Minnesota.
currentStudentByCampus
This endpoint provides affiliation information for students enrolled in the current term by primary campus where campus code is provided as input.
activeEmployeesByZdeptid
This endpoint will provide a list of active employees for a given ZDeptid or ZDeptids at the University of Minnesota.
Data Classification: Public
Data Currency: less than 24-hours behind the transactional data source (nightly reconciliation update)
This API service provides information related to class including Instructor information, course information etc.,
ClassInstructorList
For a given Term and Class Number, this endpoint returns a list of instructors along with their role code.
multipleClassInstructorList
This endpoint will return a list of instructors associated with the class, such as Primary, Secondary, and TA. The request can include a group of Terms and Class numbers or a group of Terms, Subject Codes, Class Catalog Numbesr, and Class Section Codes or a group of Terms, Subject Codes, Class Catalog Numbers, Class Section Codes, and Instructor Role Codes or a group of Terms, Class Numbers, and Instructor Role Codes.
classMeetingPattern
This endpoint will return a class meeting pattern. The request can include a group of Class Numbers and Term Codes.
Data Classification: Public
Data Currency: less than 24-hours behind the transactional data source (nightly reconciliation update)
This API Service provides information for employees of the University of Minnesota, including job, position, and other information.
MultipleEmployeeJobPositionInformation
For a given list of PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return the employee's job and position related information. The optional parameter job_type allows you to specify which jobs to return. Enter ACT to get all active jobs, ALL to get all jobs (active and inactive), PRM to get primary job only. If no parameter is provided, the primary job will be returned.
MultipleEmployeeSupervisorInformation
For a given list of PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return that employee's supervisor information. The reports to position number for the employee's job is used to identify their supervisor. The optional parameter job_type allows you to specify which job's supervisor to return. Enter ACT to get supervisor information for all active jobs, ALL to get supervisor for all jobs (active and inactive), PRM to get supervisor of the primary job only. If no parameter is provided, the primary will be returned. When multiple supervisors are returned, the Primary (if any) is first, followed by secondary jobs in Position order. If the supervisor has multiple jobs, the position information returned is for the reports to position, which may not be the supervisor's primary job.
employeePayInformation
For a given list of PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint provides information about additional pay. Some returned items include earn code, additional pay amount, and additional pay end date.
This API service provides information indicating an individual works/teaches/studies in a department or academic program that is subject to Private Health Information (PHI) policies. The data classification for this API is Public.
personHealthCareIndicator
For a given emplid/internet ID or list of emplids/internet IDs, this endpoint returns the HCC Indicator where it exists for an individual.
Data Classification: Public
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API service provides information associated with HR employment, such as data about jobs and positions. The data classification for this API is Public.
hrCountryCode
For a given country code or list of country codes, this endpoint provides country name. If no country code is entered, all records are returned.
hrJobCode
For a given job code or list of job codes, this endpoint provides information about job code, such as title, group code, and other characteristics associated with job code. If no job code is entered, all records are returned.
hrJobEmployeeClass
For a given job code or list of jobcodes, this endpoint provides information about the employee classification codes associated with those jobcodes. If no valid jobcode is entered, no data is returned.
hrJobFamilyCode
For a given job family code or list of job family codes, this endpoint provides short and long description associated with job family code. If no job family code is entered, all records are returned.
hrLocationCode
For a given location code or list of location codes, this endpoint provides information about locations, such as country code, location long description, and other characteristics associated with location. If no location code is entered, all records are returned.
hrPersonInformation
For a given list of PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return recent background check date and safety of minor indicator, if available, for each person.
hrPositionInformation
For a given position number or list of position numbers, this endpoint provides information about HR Positions, such as title, department, location, associated jobcode, and other characteristics. If no valid position number is entered, no data is returned.
Data Classification: Public
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API service provides organizational information for departments. The Data Classification for this API is Public.
multipleDepartmentFinancialInfo
For a given Department ID (or list of Department IDs), this endpoint returns financial organization information such as deptid description, admin unit/description, RRC code/description, and ZDeptID/description.
multipleDepartmentHRInfo
For a given Department ID (or list of Department IDs), this endpoint returns human resource organization information such as deptid description, admin unit/description, college admission unit code/description, and ZDeptID/description.
Data Classification: Private-Restricted
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API service provides address information for persons affiliated with the University of Minnesota including address and address type. The Data Classification for this API is Private-Restricted.
personAddressInformation
For a given list of Emplids and/or Internet IDs, this endpoint will return address information. The optional parameter of address_type allows for specification of a particular address type. If no address_type is specified, all relevant address types are returned.
Data Classification: Public
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API Service provides basic contact information for persons affiliated with the University of Minnesota, including name physical address, email address, and phone number.
PersonCampusContact
For a given PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return the person's campus address and campus phone number, if available. Not all persons will have a campus address and/or campus phone number.
PersonContactInformation
For a given PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return the person's display name and institutional email address. For students, the FERPA code and FERPA code description will also be returned, if applicable. It is your responsibility, based on business context, to interpret the FERPA code to determine whether information should be displayed.
MultiplePersonCampusContactInformation
For a given list of PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return the person's campus address and campus phone number, if available. Not all persons will have a campus address and/or campus phone number.
MultiplePersonContactInformation
For a given list of PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return the person's display name and institutional email address. For students, the FERPA code and FERPA code description will also be returned, if applicable. It is your responsibility, based on business context, to interpret the FERPA code to determine whether information should be displayed.
Data Classification: Highly-Restricted
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API service provides date of birth for persons at the University of Minnesota.
personDateOfBirth
For a given Person ID (Empl ID) or Internet ID, or a list of Person IDs (Empl ID) or Internet IDs, this endpoint will return the date of birth for each person.
Data Classification: Private-Restricted
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API service provides email information for persons affiliated with the University of Minnesota including email address, email address type, and preference indicator. The Data Classification for this API is Private-Restricted.
personEmailAddressInformation
For a given list of Emplids and/or Internet IDs, this endpoint will return email information. Optionally, email address type can be requested. If no particular email address type is needed, pass a null value.
Data Classification: Private-Restricted
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API service provides legal name information for persons associated with the University of Minnesota. The data classification for this API is Private Restricted.
personLegalName
For a given emplid or internet_id or list of emplids or internet_ids, this endpoint provides legal name information including first, middle, last, and full name for persons associated with the University of Minnesota. If no valid emplid or internet_id is entered, no data is returned.
Data Classification: Highly-Restricted
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API Service provides the legal sex description for persons at the University of Minnesota.
personLegalSex
For a given Person ID (Empl ID) or Internet ID, or a list of Person IDs (Empl ID) or Internet IDs, this endpoint will return the legal sex description for each person.
Data Classification: Private-Restricted
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API service provides phone information for persons affiliated with the University of Minnesota including phone type, number, extension, country code, and preference indicator. The Data Classification for this API is Private-Restricted.
personPhoneInformation
For a given list of Emplids and/or Internet IDs, this endpoint will return phone information. Phone type code is not required.
Data Classification: Private-Restricted
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API Service provides UCard information.
default
For a given Person ID (Empl ID) or Internet ID or UCard, this endpoint will return the person's active UCard number, if available. If a card has been marked lost or has not yet been issued, no data will be returned.
multipleUCardNumber
Given a list of Person IDs (Empl IDs) or Internet IDs or UCards this endpoint will return a list of their active UCard numbers. If a person does not have a UCard, or if the UCard is lost, no data will be returned for that person.
Data Classification: Private-Restricted (due to the inclusion of Proximity Number data, approval from Office of Public Safety is required)
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API Service provides the UCard number and associated proximity number for door access.
default
For a given PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return the person's active UCard number and Proximity number. If a person does not have a UCard, or if the UCard is lost, no data will be returned for that person.
multipleUCardProximity
Given a list of PeopleSoft Person IDs (Empl IDs) this endpoint will return a list of active UCard numbers and Proximity numbers. If a person does not have a UCard, or if the UCard is lost, no data will be returned for that person.
Data Classification: Highly-Restricted
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API Service provides personal pronoun information for persons affiliated with the University of Minnesota.
detail
For a given PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return the person's preferred pronoun information, if available. Not all persons will have a designated personal pronoun.
personPersonalPronoun
For a given Person ID (Empl ID) or Internet ID, or a list of Person IDs (Empl ID) or Internet IDs, this endpoint will return the preferred pronoun information for each person, if available. Not all persons have designated a personal pronoun.
Data Classification: Public
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API service provides information associated with non-student Persons of Interest, including information about their role and where they report. The data classification for this API is Public.
poiInformation
For a given emplid or internet_id or list of emplids or internet_ids, this endpoint provides information about non-student Persons of Interest, such as POI type, department, supervisor information, and other characteristics. If no valid emplid or internet_id is entered, no data is returned.
Data Classification: Public
Data Currency: less than 24-hours behind the transactional data source (nightly reconciliation update)
This API Service provides RRC and Chief Financial Manager contacts for a given financial organization. The Data Classification for this API is Public.
rrcContactInformation
This endpoint will return RRC and Chief Financial Manager contacts. If no specific deptIds are requested as input parameters, the entire data set will be returned.
Data Classification: Private-Restricted
Data Currency: less than 24-hours behind the transactional data source (nightly reconciliation update)
This API service provides information on collaborators not formally affiliated with the University who have been granted access to University resources for the purpose of providing support for instruction, research, or administrative services. Example: Vendors, Contractors, etc. The data classification for this API is Private Restricted.
sponsoredAccountByExpirationDate
For a given a date range, this endpoint will return all Sponsored Accounts expiring within that date range. Dates must be in YYYY-MM-DD format.
sponsoredAccountByInternetId
For a given list of Internet IDs, this endpoint will return sponsored account information. If no is specified, all relevant address types are returned.
sponsoredAccountInformation
For all sponsored accounts, this endpoint will return all stored information for each account.
Data Classification: Private-Restricted
Data Currency: less than 24-hours behind the transactional data source (nightly reconciliation update)
This API service provides information for students of the University of Minnesota, including course enrollment and academic program information.
ClassEnrollmentList
For a given Term, Subject, Catalog Number, and Class Section, this endpoint will return a list of students enrolled in that Class Section.
CourseEnrollment
For a given PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return a student's course information based on the parameters provided. Options include returning courses based on enrollment status - enrolled (ENRL), waitlisted (WAIT), dropped (DROP), or all statuses (ALL). Courses can also be selected based on term - for a particular term (<term code>), or all (ALL) term codes. If no optional parameters are included, the endpoint returns enrolled classes for the current term.
Default Example: https://integration-boomi.umn.edu/prd/ws/rest/studentAcademic/getCourseEnrollment/<internet id or Empl id>
Custom Enrollment Status Example: https://integration-boomi.umn.edu/prd/ws/rest/studentAcademic/getCourseEnrollment/<internet id or Empl id>/WAIT
Custom Enrollment Status and Term Example: https://integration-boomi.umn.edu/prd/ws/rest/studentAcademic/getCourseEnrollment/<internet id or Empl id>/ENRL/1215
Custom Term Code Example: https://integration-boomi.umn.edu/prd/ws/rest/studentAcademic/getCourseEnrollment/<internet id or Empl id>/1215
ProgramInfo
For a given PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return a student's program data. Program Status parameter allows returning all programs and statuses (ALL), active programs (ACT), completed (COMPL) programs, admitted programs (ADMT), and programs applied to (APP).
StudentCharacteristic
For a given PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return an active student's Primary Campus Code information. The person must be a currently active student or no data will be returned for that person.
classWaitlistList
For a given Term and Class Number, this endpoint will return a list of Waitlist students in that course.
multipleClassEnrollmentList
This endpoint will return a list of students enrolled in a particular course. The request can include a group of Terms and Class Numbers or a group of Terms, Class Catalog Numbers, Subjects, and Class Sections.
multipleClassWaitlistInformation
For given Term and Class Number combinations, this endpoint will return a list of Waitlist students in that class.
multipleCourseEnrollmentInformation
For a given group of PeopleSoft Person IDs (Empl IDs) or Internet IDs, this endpoint will return student's course enrollment for the current academic term. Optional parameters include term and enrollment status (ENRL, WAIT, DROP). An empty value for the optional parameters will return ALL available data.
multipleProgramInfo
For a given PeopleSoft Person ID (Empl ID) or Internet ID, or a list of IDs, this endpoint will return a student's program data. The optional Program Status parameter allows returning all programs when set blank or active programs (ACT), completed (COMPL) programs, admitted programs (ADMT), and programs applied to (APP).
multipleStudentCharacteristic
For a given list of PeopleSoft Empl IDs or Internet ID, this endpoint will return a list of student Primary Campus Code information. The students must be currently active or no data will be returned for that person.
multipleStudentGroupMembership
For a given PeopleSoft Person ID (Empl ID) or Internet ID, or a list of IDs, this endpoint will return a list of a student's group membership and whether they are active or inactive in that group. If a date is provided the group status will be as of that date. If no date is entered the group status will be as of the current date.
multiTermGracePeriodInfo
For a given PeopleSoft Person ID (Empl ID) or Internet ID, this endpoint will return an active student's Term & Grace Period information. The person must be a currently active student or no data will be returned for that person.
studentAcademicLevel
This endpoint will return a student's academic level for a given term. The return will include projected code level, beginning of term code level, and end of term level code.
Data Classification: Public
Data Currency: less than 10-minutes behind the transactional data source (near real-time and nightly reconciliation updates)
This API Service provides term related information for the University of Minnesota.
activeTerm
This endpoint will return term related information where the current date falls within a term period. Optional parameters include institution and academic career.
latestTerm
This endpoint will return term related information where the current date corresponds with the term that began most recently. Optional parameters include institution and academic career.
soonestTerm
This endpoint will return term related information where the current date corresponds with the term that ends next. Optional parameters include institution and academic career.
termByCode
This endpoint will return term related information for the term code value provided. Optional parameters include institution and academic career.
termByDate
This endpoint will return term related information for the date provided (format MM/DD/YYYY). Optional parameters include institution and academic career.
Data Classification: Private-Restricted
UCard Photo Access API retrieves photos from UCard photo share. Takes input ( SA#, internet_id, or EmplId ) and returns json output, containing Base64 encoded file contents.
PhotoRetrieval
Retrieves UCard Photo from Staff/Student's SA#
PhotoRetrievalByEmplId
Retrieves UCard Photo from Staff/Student's Emplid
PhotoRetrievalByInternetId
Retrieves UCard Photo from Staff/Student's InternetId
Page updated
Report abuse