MAUI

APIReader (Services for providing api documentation)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/documentation/all

Gets all the API documentation for MAUI web services

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/documentation/resource

Gets the API documentation for a provided operation

Implementation Notes

The matching performed in this service looks for the first resource that contains the provided operation path, contains a '/' and is at least 3 characters

Parameters

Parameter	Value	Parameter Type	Description
resource		query	The resource path of the api you want

Headers

Name	Value
Accept
Content-Type

GET /pub/documentation/api

Gets the API documentation for a provided resource

Parameters

Parameter	Value	Parameter Type	Description
api		query	The resource path of the api you want

Headers

Name	Value
Accept
Content-Type

AcademicEnrollments (Operations about academic enrollments)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/enrollments/{sessionId:[/d]+}/{academicId}

Fetch all enrollments for a given session and student

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The internal session id that the student is signing the agreement for (i.e. 47 for Spring 2012, not 20118)
academicId		path	The internal academic id for the student signing the agreement

Headers

Name	Value
Accept
Content-Type

GET /auth/registrar/enrollments/{academicEnrollmentId:[/d]+}

Find an enrollment by id

Parameters

Parameter	Value	Parameter Type	Description
academicEnrollmentId		path	The internal academic enrollment id of the enrollment you would like to fetch

Headers

Name	Value
Accept
Content-Type

AcademicOffices (Academic Offices Web Service Providing Sync Feed Mainly to Universal Workflow)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/offices/sync

Fetch active academic offices

Implementation Notes

This web service provide academic office sync feed mainly to Universal Workflow

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

AcademicProgress (Integration point for ISIS initiated Academic Progress Appeals)

Show/Hide
List Operations
Expand Operations
Raw

AcademicProgressAppealForm (Integration point for Workflow notifications/callbacks)

Show/Hide
List Operations
Expand Operations
Raw

AcademicProgressDispatch (Financial Aid service for sending satisfactory academic progress notifications via Dispatch)

Show/Hide
List Operations
Expand Operations
Raw

AcademicStandingNotice (Academic Standing Letters and Emails)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/academicStanding

Find Academic Standing Notices

Parameters

Parameter	Value	Parameter Type	Description
college		query
address		query
standing		query
decision		query
term		query

Headers

Name	Value
Accept
Content-Type

AcademicUnit (Operations about Academic Units)

Show/Hide
List Operations
Expand Operations
Raw

Parameter	Value	Parameter Type	Description
id		path	The internal id of the academic unit

Parameter	Value	Parameter Type	Description
nk		path	The natural key of the academic unit

Parameter	Value	Parameter Type	Description
id		path	The internal id of the academic unit

Parameter	Value	Parameter Type	Description
nk		path	The natural key of the child academic unit

Parameter	Value	Parameter Type	Description
college		path	The internal id of the college you would like departments for

Parameter	Value	Parameter Type	Description
collegeNatKey		path	The natural key of the college you would like departments for

Parameter	Value	Parameter Type	Description
collegeId		path	The internal id of the college you would like course offereing units for

GET /auth/arch/access/report/access/{uid}

Verify user has access to a report.

Implementation Notes

Verifies user has a MAUI account and they can should be authorized for the requested report.

Parameters

Parameter	Value	Parameter Type	Description
uid		path
report_id		query
campus_data_id		query

Headers

Name	Value
Accept
Content-Type

GET /auth/arch/access/report/check-access/{uid}

Verify user has access to a report.

Implementation Notes

Verifies user has a MAUI account and they can should be authorized for the requested report.

Parameters

Parameter	Value	Parameter Type	Description
uid		path
report		query

Headers

Name	Value
Accept
Content-Type

AccountRestriction (Indicates billing account restrictions, registration or charging.)

Show/Hide
List Operations
Expand Operations
Raw

Advising (Public operations about advisor information)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/advising/unit-advisor-people/{advisorId}

Returns people associated with an academic unit advisor

Parameters

Parameter	Value	Parameter Type	Description
advisorId		path	Advisor ID

Headers

Name	Value
Accept
Content-Type

GET /auth/registrar/advising/search/{searchString}

Find advisors based on a 'smart' query engine. See notes for more info

Implementation Notes

Order of search operations:

* If it looks like a university id then searching is done for advisors with a matching UID

* If it looks like a legacy advisor code then searching is done via this

* If it looks like a hawk id AND a hawk id search returns results, then this is used

* If it looks like a first + last name and the search returns results, then this is used

* If a search by name returns results then that is used

* Finally we search by academic unit name

Parameters

Parameter	Value	Parameter Type	Description
searchString		path	The advisor search string
includePrograms		query	Boolean flag to indicate if you want programs returned

Headers

Name	Value
Accept
Content-Type

Advisor (Operations about Advisors)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/advising/{univid:/d+}/advisees/{sessionCode}

Get an advisor's caseload in provided session

Implementation Notes

This will return the advisor's caseload for the provided session

Session should be in legacy format (i.e. 20228)

Parameters

Parameter	Value	Parameter Type	Description
univid		path	The university ID of the advisor
sessionCode		path	The session you want to search in (legacy code)

Headers

Name	Value
Accept
Content-Type

ApplicantRecommendation (Integration point for Workflow notification that a recommendation has been submitted.)

Show/Hide
List Operations
Expand Operations
Raw

ApplicantRecommendationTemp (Integration point for Workflow notification that a recommendation has been submitted.)

Show/Hide
List Operations
Expand Operations
Raw

Application (Application Web Service)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/admissions/applications/{appUuid}/documents/{docUuid}

Pull the pdf document for app and doc id.

Parameters

Parameter	Value	Parameter Type	Description
appUuid		path	Application uuid
docUuid		path	Document uuid

Headers

Name	Value
Accept
Content-Type

GET /auth/admissions/applications/{appUuid}

Find application data

Parameters

Parameter	Value	Parameter Type	Description
appUuid		path	Application uuid

Headers

Name	Value
Accept
Content-Type

GET /auth/admissions/applications

Find applications for department

Parameters

Parameter	Value	Parameter Type	Description
levelOfStudy		query
programCollege		query
program		query
session		query

Headers

Name	Value
Accept
Content-Type

Appointment (Operations about Student Advising Appointments)

Show/Hide
List Operations
Expand Operations
Raw

Assessment (Read a student's assessment data)

Show/Hide
List Operations
Expand Operations
Raw

AstraBldgRmCompleteList (Astra Complete Building and Room List)

Show/Hide
List Operations
Expand Operations
Raw

AstraRoomData (Astra Data For Individual Room)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/courses/AstraRoomData/{bldgCode}/{roomNumber}

Provides data for a given room.

Parameters

Parameter	Value	Parameter Type	Description
bldgCode		path	The building code needs to match the code as it is entered in Astra.
roomNumber		path	The room number needs to match the code as it is entered in Astra.

Headers

Name	Value
Accept
Content-Type

AstraRoomSchedule (Astra Room Schedule Information)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/courses/AstraRoomSchedule/{startDate}/{endDate}/{bldgCode}/{roomNumber}

Provides the schedule for a given room for the given date range

Parameters

Parameter	Parameter Type	Description
startDate	path	Start date needs to be in format of YYYY-MM-DD.
endDate	path	End date needs to be in format of YYYY-MM-DD.
bldgCode	path	The building code needs to match the code as it is entered in Astra. Please contact the Registrar's Office if needed.
roomNumber	path	The room number needs to match the code as it is entered in Astra. Please contact the Registrar's Office if needed.

Headers

Name	Value
Accept
Content-Type

AwardLetter (Financial Aid services for sending award letters via Dispatch)

Show/Hide
List Operations
Expand Operations
Raw

AwardLetterCloudFile (Service to get the award letter pdfs stored in cloud server)

Show/Hide
List Operations
Expand Operations
Raw

BatchJobMonitor (Get alert messages for Dispatch concerning Billing batch jobs that did not run properly.)

Show/Hide
List Operations
Expand Operations
Raw

BillingDocument (Generate Billing documents for an individual using a Freemarker template.)

Show/Hide
List Operations
Expand Operations
Raw

CampusDataWarehouse (Integration point for Campus Data warehouse access requests.)

Show/Hide
List Operations
Expand Operations
Raw

CatalogCourse (Operations about courses)

Show/Hide
List Operations
Expand Operations
Raw

ChangeOfCollege (Integration point for Workflow callbacks and ISIS data source)

Show/Hide
List Operations
Expand Operations
Raw

ChangeOfCollegeForm (Integration point for Workflow callbacks and JSON data sources)

Show/Hide
List Operations
Expand Operations
Raw

ClassList (Classlist for a course and session)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/courses/classlist/{sessionId}/{subject}/{course}

Find classlist by session, subject and course

Implementation Notes

Session should be in legacy format (i.e. 20128) This service allows seaches by either legacy course numbers (i.e. XXX:XXX:XXX) or updated course numbers (i.e. XXXX:XXXX:XXXX) To also include instructors with the class list, pass along the optional query parameter of 'includeInstructors=true'

Parameters

Parameter	Parameter Type	Description
sessionId	path	The session you want to search in (legacy code)
subject	path	The subject you are searching for for
course	path	The course number you are searching for
includeInstructors	query	Use 'true' to get instructors
includeCreditHours	query	Use 'true' to get enrollment credit hours
includeNotEnrolled	query	Use 'true' to get enrollment status, 'false' to get only enrolled students
includeEmailRoutingAddress	query	Use 'true' to get email routing address

Headers

Name	Value
Accept
Content-Type

GET /auth/registrar/courses/classlist/{courseGradeCycleLookup}/{sessionId}/{subject}/{course}/{section}/{hawkid}

Find Attending, Midterm or Finals list by session, subject, course and section

Implementation Notes

courseGradeCycleLookup should be 'ATTEND', 'MIDTERM' or 'FINAL' Session should be in legacy format (i.e. 20128) This service allows seaches by either legacy course numbers (i.e. XXX:XXX:XXX) or updated course numbers (i.e. XXXX:XXXX:XXXX)

Parameters

Parameter	Parameter Type	Description
courseGradeCycleLookup	path	The type of a list, Attending, Midterm or Final list
sessionId	path	The session you want to search in (legacy code)
subject	path	The subject you are searching for for
course	path	The course number you are searching for
section	path	The section number you are searching for
hawkid	path	The hawkid of person initiating this request

Headers

Name	Value
Accept
Content-Type

GET /auth/registrar/courses/classlist/{sessionId}/{subject}/{course}/{section}

Find a classlist by session, subject, course and section

Implementation Notes

Session should be in legacy format (i.e. 20128) This service allows seaches by either legacy course numbers (i.e. XXX:XXX:XXX) or updated course numbers (i.e. XXXX:XXXX:XXXX) To also include instructors with the class list, pass along the optional query parameter of 'includeInstructors=true'

Parameters

Parameter	Parameter Type	Description
sessionId	path	The session you want to search in (legacy code)
subject	path	The subject you are searching for for
course	path	The course number you are searching for
section	path	The section number you are searching for
includeInstructors	query	Use 'true' to get instructors
includeCreditHours	query	Use 'true' to get enrollment credit hours
includeNotEnrolled	query	Use 'true' to get enrollment status, 'false' to get only enrolled students
includeEmailRoutingAddress	query	Use 'true' to get email routing address
includeAccommodations	query

Headers

Name	Value
Accept
Content-Type

CohortList (List of students for a cohort, begin/end session)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/cohortlist

Find students by cohort, begin and end session

Implementation Notes

Cohort should be natural key (i.e. PSEO, VET)

Sessions should be in legacy format (i.e. 20128)

Include withdrawn students (i.e. true, false)

Parameters

Parameter	Parameter Type	Description
cohort	query	The cohort you search for (natural key)
effectiveSession	query	The effective session you search for (legacy code)
endSession	query	The end session you search for (legacy code)
includeWithdrawn	query	Boolean flag to indicate if you want to include withdrawn students

Headers

Name	Value
Accept
Content-Type

CommencementMode (Commencement Modes (Virtual/In Person))

Show/Hide
List Operations
Expand Operations
Raw

Course (Operations about courses)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/course/search

Search course data. Supports full text searches and defaults to current session.

Parameters

Parameter	Parameter Type	Description
sessionCode	query
fullTextQuery	query
titleAndTextQuery	query
fullTextFields	query	Specify fields/boosts to search with fullTextQuery
customFields	query	When fullTextFields=CUSTOM, use this field to provide custom fields to search. See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_multi_field for possibilities
courseSubject	query
courseNumber	query
genEds	query	Natural keys from https://www.maui.uiowa.edu/maui/registrar/courses/library/CourseGenEdLookup/manage.page
genEdProgram	query
genEdCollegeId	query
levels	query	Natural keys from https://www.maui.uiowa.edu/maui/registrar/courses/library/CourseLevelLookup/manage.page
onlyOffered	query
statuses	query	Specify course approval statuses to filter on
courseId	query
size	query
from	query
sort	query	Specify result ordering

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/course/{courseIdentifier}

Find a course by course identifier

Parameters

Parameter	Value	Parameter Type	Description
courseIdentifier		path	The identifier for the course. Can use new (CHEM:1110) or old (004:011) numbers

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/course/dropdown/{session}/{subject}

Provide a list of values for a course number dropdown based on session and course subject

Parameters

Parameter	Value	Parameter Type	Description
session		path
subject		path

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/course/find-identity/{identityId}

Find a course identity by the course identity id. Attempts to quick load from ES, but will fall back to live data

Parameters

Parameter	Value	Parameter Type	Description
identityId		path

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/course/course-library/courses

Provide list of current/future courses that are not currently dropped in course library

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

POST /pub/registrar/course/search

Search course data. Supports full text searches and defaults to current session.

Parameters

Parameter	Value	Parameter Type	Description
		body	(The object used for defining a course search) Model Attributes sessionCode fullTextQuery titleAndTextQuery fullTextFields - (Specify fields/boosts to search with fullTextQuery) customFields - (When fullTextFields=CUSTOM, use this field to provide custom fields to search. See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_multi_field for possibilities) courseSubject courseNumber genEds - (Natural keys from https://www.maui.uiowa.edu/maui/registrar/courses/library/CourseGenEdLookup/manage.page) genEdProgram genEdCollegeId levels - (Natural keys from https://www.maui.uiowa.edu/maui/registrar/courses/library/CourseLevelLookup/manage.page) onlyOffered statuses - (Specify course approval statuses to filter on) courseId size from sort - (Specify result ordering)

Headers

Name	Value
Accept
Content-Type

CourseGenEd (Operations about Course Gen Eds)

Show/Hide
List Operations
Expand Operations
Raw

CourseGroup (Operations about Courses Groups)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/cic/{cicId:[/d]+}

Find a specific CIC option based on internal id

Parameters

Parameter	Value	Parameter Type	Description
cicId		path	The internal id of the CIC you want to find

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/cic

Find all CIC options for a given session

Parameters

Parameter	Value	Parameter Type	Description
session		query	The internal session id to search by (i.e. 47 for Spring 2012, not 20118)

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/cic/seats/{cicId_csv}

Fetch a map of option ids to seat count objects

Parameters

Parameter	Value	Parameter Type	Description
cicId_csv		path	The internal ids of the CIC options you want to find seats for in CSV format

Headers

Name	Value
Accept
Content-Type

CourseInstructor (Course Instructor Information)

Show/Hide
List Operations
Expand Operations
Raw

CourseSection (Operations about courses/sections)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/sections/{sectionId: /d+}

Find a section by section internal id

Parameters

Parameter	Value	Parameter Type	Description
sectionId		path	The section id
exclude		query	The exclusion parameters as JSON Example: {"textBooks": true} (Flags for specifying which (public) information to be excluded from section search results - [true == exclude]) Model Attributes courseIdentity prereq courseTitle enrollments instructors restrictions timesAndLocations textBooks - ((excluded by default)(exclude to use materialized view)) courseFees - ((excluded by default)(exclude to use materialized view)) adminAndCollegeInfo - ((excluded by default)(exclude to use materialized view)) coexistingSectionsInfo - ((excluded by default)(exclude to use materialized view)) repeatbility - ((excluded by default)(exclude to use materialized view)) gradingInstruction - ((excluded by default)(exclude to use materialized view)) coreq - ((excluded by default)(exclude to use materialized view)) genEd - ((excluded by default)(exclude to use materialized view)) sectionRequirement - ((excluded by default)) courseTexts - ((excluded by default)(exclude to use materialized view)) lfuLookups - ((excluded by default)(exclude to use materialized view)) sectionTexts - ((excluded by default)(exclude to use materialized view)) sectionGroups - ((excluded by default)) lastDays - ((excluded by default))

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/dropdown/{session}/{subject}/{course}

Provide a list of values for a section number dropdown based on session, course subject, and course number

Parameters

Parameter	Value	Parameter Type	Description
session		path
subject		path
course		path

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/related/{relationship: preferred|mandatory}/{courseIdentityId:[/d]+}/{sectionId:[/d]+}

Find all section types related to the given section by the given relationship type

Parameters

Parameter	Parameter Type	Description
sectionId	path	Internal course section id
courseIdentityId	path	Internal course identity id
relationship	path	The relationship type you want to inspect

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/legacySection/{sessionCode:/d{5}}/{subject:/w{3}}/{course:/w{3}}/{section:/w{3}}

Find a section by session, department, course and section all in LEGACY format

Parameters

Parameter	Parameter Type	Description
sessionCode	path	The session you want to search in
subject	path	The legacy department you are searching for for
course	path	The legacy course number you are searching for
section	path	The legacy section number you are searching for

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/saturday-and-evening/{sessionCode}

Find all Saturday and evening classes by legacy session id

Implementation Notes

The session code should be of the legacy format (i.e. 20118)

The data that can be returned here is limited by how far back the materialized view holds data and far forward data has been built

Parameters

Parameter	Value	Parameter Type	Description
sessionCode		path	The session you want sections for

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/{sessionCode:/d{5}}/{subject:/w{2,4}}

Find sections by session and subject

Implementation Notes

Session code should be in legacy format (i.e. 20118)

Because this service is intended to be fast it runs from the materialized views and is limited by them

Parameters

Parameter	Value	Parameter Type	Description
sessionCode		path	The session you want sections for
subject		path	The subject you want sections for

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/{sessionCode:/d{5}}/{subject:/w{2,4}}/{course:/w{3,4}}

Find sections by session, subject and course

Implementation Notes

Session code should be in legacy format (i.e. 20118)

Because this service is intended to be fast it runs from the materialized views and is limited by them

To get detailed data (slower), pass along the optional query parameter of 'complex=true'

Parameters

Parameter	Parameter Type	Description
sessionCode	path	The session you want sections for
subject	path	The subject you want sections for
course	path	The course you want sections for
complex	query	Whether or not you want to just get back simple data (it is faster to get simple data). Use 'true' to get detailed data

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/{sessionCode:/d{5}}/{subject:/w{2,4}}/{course:/w{3,4}}/{section:/w{3,4}}

Find a section by session, subject, course and section

Implementation Notes

Session code should be in legacy format (i.e. 20118)

This service will default to grabbing detail information and must go against live data to do so

To get your data faster and in the format of the browsing services (less information), you can pass along the optional query parameter of 'simple=true'

Parameters

Parameter	Parameter Type	Description
sessionCode	path	The session you want to search in
subject	path	The subject you are searching for for
course	path	The course number you are searching for
section	path	The section number you are searching for
simple	query	Whether or not you want to just get back simple data (it is faster to get simple data). Use 'true' to get simple data
format	query	The format you want to receive. 'simple' gives back the bare bones, 'complex' gives back the kitchen sink, anything else gives all data that can be retrieved quickly

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/{sectionId:/d+}/{courseIdentityId:/d+}

Find a single section by internal ids

Parameters

Parameter	Parameter Type	Description
sectionId	path	Internal course section id
courseIdentityId	path	Internal course identity id
exclude	query	The exclusion parameters as JSON Example: {"textBooks": true} (Flags for specifying which (public) information to be excluded from section search results - [true == exclude]) Model Attributes courseIdentity prereq courseTitle enrollments instructors restrictions timesAndLocations textBooks - ((excluded by default)(exclude to use materialized view)) courseFees - ((excluded by default)(exclude to use materialized view)) adminAndCollegeInfo - ((excluded by default)(exclude to use materialized view)) coexistingSectionsInfo - ((excluded by default)(exclude to use materialized view)) repeatbility - ((excluded by default)(exclude to use materialized view)) gradingInstruction - ((excluded by default)(exclude to use materialized view)) coreq - ((excluded by default)(exclude to use materialized view)) genEd - ((excluded by default)(exclude to use materialized view)) sectionRequirement - ((excluded by default)) courseTexts - ((excluded by default)(exclude to use materialized view)) lfuLookups - ((excluded by default)(exclude to use materialized view)) sectionTexts - ((excluded by default)(exclude to use materialized view)) sectionGroups - ((excluded by default)) lastDays - ((excluded by default))

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections

The section/course search web service

Implementation Notes

This provides support to very dynamic searches, but may be hard to test in the api explorer

This difficulty is due to the fact the parameters are a fairly complex JSON object

Response type is ResultDTO<SectionDTO>

Parameters

Parameter	Parameter Type	Description
json	query	The search parameters as JSON Example: {"sessionId": 47, "courseSubject": "chem", "courseNumber": "1110"} (The object used for defining a course search) Model Attributes fullTextSearch courseId sort sessionId - (The internal session id) academicUnitId courseSubject legacyDeptCode legacyCourseNumber courseNumber sectionNumber courseType showHonors showTile keywords instructors courseLevels creditHours courseCategories learningTypes deliveryModes learningCenters regions managementTypeGroups genEd genEdCollege genEdProgram genEds genEdList learningCenter matchAll sun mon tue wed thu fri sat startTime endTime wk3 wk4 wk6 wk6ii wk8 wk12 offcycle startDate arrangedTime saturdayAndEvening distanceEd onWeb onIcn ignoreConcreteIndependentStudy onlyOpen pageStart pageSize
exclude	query	The exclusion parameters as JSON Example: {"textBooks": true} (Flags for specifying which (public) information to be excluded from section search results - [true == exclude]) Model Attributes courseIdentity prereq courseTitle enrollments instructors restrictions timesAndLocations textBooks - ((excluded by default)(exclude to use materialized view)) courseFees - ((excluded by default)(exclude to use materialized view)) adminAndCollegeInfo - ((excluded by default)(exclude to use materialized view)) coexistingSectionsInfo - ((excluded by default)(exclude to use materialized view)) repeatbility - ((excluded by default)(exclude to use materialized view)) gradingInstruction - ((excluded by default)(exclude to use materialized view)) coreq - ((excluded by default)(exclude to use materialized view)) genEd - ((excluded by default)(exclude to use materialized view)) sectionRequirement - ((excluded by default)) courseTexts - ((excluded by default)(exclude to use materialized view)) lfuLookups - ((excluded by default)(exclude to use materialized view)) sectionTexts - ((excluded by default)(exclude to use materialized view)) sectionGroups - ((excluded by default)) lastDays - ((excluded by default))
pageStart	query	The index of the found sections you want to start at
pageSize	query	The number of results you want per page (per request)

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/full-text

Full Text Search. Like Google

Parameters

Parameter	Value	Parameter Type	Description
q		query
start		query
size		query

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/{sectionId:/d+}/{courseIdentityId:/d+}/{relationshipType:related-mandatory-sections|related-preferred-sections|preferred|mandatory}/{sectionType}

Find related sections to a given section

Implementation Notes

This web service will find all related sections to a given section with a specified relationship of a specific section type

For example, you can find all related mandatory lectures to a given discussion. This is not a common relationship, but you get the idea

This web service will attempt to hit materialized views depending on the exclusions sent (refer to param model for more information

Response type is ResultDTO<SectionDTO>

Parameters

Parameter	Parameter Type	Description
sectionId	path	The internal section id of the base section you want to find related sections to
courseIdentityId	path	The internal course identity id of the base section you want to find related sections to
relationshipType	path	The relationship type you want to inspect
sectionType	path	The section type you want returned
exclude	query	The exclusion parameters as JSON Example: {"textBooks": true} (Flags for specifying which (public) information to be excluded from section search results - [true == exclude]) Model Attributes courseIdentity prereq courseTitle enrollments instructors restrictions timesAndLocations textBooks - ((excluded by default)(exclude to use materialized view)) courseFees - ((excluded by default)(exclude to use materialized view)) adminAndCollegeInfo - ((excluded by default)(exclude to use materialized view)) coexistingSectionsInfo - ((excluded by default)(exclude to use materialized view)) repeatbility - ((excluded by default)(exclude to use materialized view)) gradingInstruction - ((excluded by default)(exclude to use materialized view)) coreq - ((excluded by default)(exclude to use materialized view)) genEd - ((excluded by default)(exclude to use materialized view)) sectionRequirement - ((excluded by default)) courseTexts - ((excluded by default)(exclude to use materialized view)) lfuLookups - ((excluded by default)(exclude to use materialized view)) sectionTexts - ((excluded by default)(exclude to use materialized view)) sectionGroups - ((excluded by default)) lastDays - ((excluded by default))

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/viable-options/{sessionId: /d+}/{courseIdentityId: /d+}/{sectionId: /d+}

Find sections that an enrollment for this section may change to

Implementation Notes

Because there are some courses that can go between stand alone and multipart, this web service is necessary

If each change was a simple one - to - one change, then we could just use the related sections service

Parameters

Parameter	Parameter Type	Description
sessionId	path	Internal session id (NOT 20118...)
courseIdentityId	path	Internal course identity id of the section you want to find valid change sections for
sectionId	path	Internal course section id of the section you want to find valid change sections for

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/enrollments-n-status/{sessionId:[/d]+}/{sectionIds_csv}

Fetch the enrollments and status for a list of sections

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	Internal session id (NOT 20118...)
sectionIds_csv		path	List of comma separated internal section ids

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/{sectionId:[/d]+}/instructors

Find all instructors for the given section

Implementation Notes

Because no course identity is asked for, the administrative home identity is used

Parameters

Parameter	Value	Parameter Type	Description
sectionId		path	Internal course section id

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sections/restrict-enrollments/{sectionId: /d+}

Find the enrollment information for each seat restriction on a section

Implementation Notes

Because restrictions are on the section level, course identity does not matter in this case

Parameters

Parameter	Value	Parameter Type	Description
sectionId		path	Internal course section id

Headers

Name	Value
Accept
Content-Type

CourseSectionSyllabus (Operations about section syllabuses)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/sections/syllabuses/{sessionId}/{subject}/{course}/{section}

Download a syllabus for a specific section by session, subject, course, and section. File is returned if found.

Implementation Notes

Session should be in legacy format (i.e. 20128) This service allows seaches by either legacy course numbers (i.e. XXX:XXX:XXX) or updated course numbers (i.e. XXXX:XXXX:XXXX)

Parameters

Parameter	Parameter Type	Description
sessionId	path	The session you want to search in (legacy code)
subject	path	The subject you are searching for for
course	path	The course number you are searching for
section	path	The section number you are searching for

Headers

Name	Value
Accept
Content-Type

DELETE /auth/registrar/sections/syllabuses/{sessionId}/{subject}/{course}

Delete a syllabus for all sections of a specific course by session, subject, and course. 204 status code if successful.

Implementation Notes

Session should be in legacy format (i.e. 20128) This service allows seaches by either legacy course numbers (i.e. XXX:XXX) or updated course numbers (i.e. XXXX:XXXX)

Parameters

Parameter	Parameter Type	Description
sessionId	path	The session you want to search in (legacy code)
subject	path	The subject you are searching for for
course	path	The course number you are searching for

Headers

Name	Value
Accept
Content-Type

PUT /auth/registrar/sections/syllabuses/{sessionId}/{subject}/{course}/{section}

Upload a syllabus for a specific section by session, subject, course, and section. File UUID is returned.

Implementation Notes

Session should be in legacy format (i.e. 20128) This service allows seaches by either legacy course numbers (i.e. XXX:XXX:XXX) or updated course numbers (i.e. XXXX:XXXX:XXXX)

Parameters

Parameter	Parameter Type	Description
sessionId	path	The session you want to search in (legacy code)
subject	path	The subject you are searching for for
course	path	The course number you are searching for
section	path	The section number you are searching for
title	query	The title of the syllabus

Headers

Name	Value
Accept
Content-Type

PUT /auth/registrar/sections/syllabuses/{sessionId}/{subject}/{course}

Upload a syllabus for a specific course by session, subject, and course. File UUID is returned.

Implementation Notes

Session should be in legacy format (i.e. 20128) This service allows seaches by either legacy course numbers (i.e. XXX:XXX) or updated course numbers (i.e. XXXX:XXXX)

Parameters

Parameter	Parameter Type	Description
sessionId	path	The session you want to search in (legacy code)
subject	path	The subject you are searching for for
course	path	The course number you are searching for
title	query	The title of the syllabus

Headers

Name	Value
Accept
Content-Type

DELETE /auth/registrar/sections/syllabuses/{sessionId}/{subject}/{course}/{section}

Delete a syllabus for a specific section by session, subject, course, and section. 204 status code if successful.

Implementation Notes

Session should be in legacy format (i.e. 20128) This service allows seaches by either legacy course numbers (i.e. XXX:XXX:XXX) or updated course numbers (i.e. XXXX:XXXX:XXXX)

Parameters

Parameter	Parameter Type	Description
sessionId	path	The session you want to search in (legacy code)
subject	path	The subject you are searching for for
course	path	The course number you are searching for
section	path	The section number you are searching for

Headers

Name	Value
Accept
Content-Type

CourseSubject (Operations about Course Subjects)

Show/Hide
List Operations
Expand Operations
Raw

CreditBalance (Get, insert or update billing account session attributes)

Show/Hide
List Operations
Expand Operations
Raw

CreditCard (Callback resource for credit card vendor to confirm payment.)

Show/Hide
List Operations
Expand Operations
Raw

POST /auth/cashnet

Confirms the completed payment via credit card.

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

DebtOverride (Get or submit debt override requests)

Show/Hide
List Operations
Expand Operations
Raw

Degree (Degree Application Communications)

Show/Hide
List Operations
Expand Operations
Raw

DeoGradeWorkflowList (DEOs for a session and workflow status)

Show/Hide
List Operations
Expand Operations
Raw

DispatchAdHocEmail (Provides callback services for Dispatch ad hoc e-mails)

Show/Hide
List Operations
Expand Operations
Raw

DispatchEmail (Provides callback services for Dispatch e-mails)

Show/Hide
List Operations
Expand Operations
Raw

DocumentDispatch (Financial Aid service for sending document requirement notifications via Dispatch)

Show/Hide
List Operations
Expand Operations
Raw

EmployerDeferral (Endpoints to manage deferment expiration emails through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

EmployerDeferredPaymentForm (Integration point for Workflow callbacks and JSON data sources)

Show/Hide
List Operations
Expand Operations
Raw

EndorsementLetter (The EndorsementLetterService provides service end-points to manage endorsement letters through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

EngineeringSupplementalApp (Engineering Supplemental Application integration point for Workflow callbacks and Dispatch notifications)

Show/Hide
List Operations
Expand Operations
Raw

EngineeringSupplementalAppEmail (Engineering Supplemental Application integration point for Workflow callbacks and Dispatch notifications)

Show/Hide
List Operations
Expand Operations
Raw

ExamSchedule (Exam schedules)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/exam-schedule/{session}

Get complete pre-formatted official final exam schedule

Implementation Notes

The session id should be of the legacy format (e.g. 20118)

Parameters

Parameter	Value	Parameter Type	Description
session		path	The session you want the exam schedule for

Headers

Name	Value
Accept
Content-Type

FacilityBuilding (Facility Building Information)

Show/Hide
List Operations
Expand Operations
Raw

FacilityBuildingRoom (Facility Building Room Information)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/facilityBuildingRoom/list

Provides a list of facility building rooms

Parameters

Parameter	Value	Parameter Type	Description
roomCategory		query	sort by room categories: UNIVERSITY_CLASSROOM, PROGRAMMED_CLASSROOM, SPECIALTY_SPACE

Headers

Name	Value
Accept
Content-Type

FedRightToCancel (The FedRightToCancelService provides service end-points to manage letters through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

FedRightToCancelEmail (The FedRightToCancelEmailService provides service end-points to manage letters through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

Finances (Get miscellaneous attributes for the MyUI Student Finances page)

Show/Hide
List Operations
Expand Operations
Raw

FinancialAidDispatch (Financial Aid service to mark communications sent via Dispatch as complete in MAUI)

Show/Hide
List Operations
Expand Operations
Raw

FinancialAidHumans (Financial Aid Services for HR)

Show/Hide
List Operations
Expand Operations
Raw

FinancialAidISIS (Financial Aid Services for ISIS)

Show/Hide
List Operations
Expand Operations
Raw

GPA (Operations about students' grades/GPAs)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/grades/current/{univIds}

Grabs a map of university ids to gpas

Parameters

Parameter	Value	Parameter Type	Description
univIds		path	Comma separated list of university ids (also works with a single university id)

Headers

Name	Value
Accept
Content-Type

GET /auth/registrar/grades/current/major/{univIds}

Map where GPA_INFO is a Map for any poses we have on record.

Parameters

Parameter	Value	Parameter Type	Description
univIds		path	Comma separated list of university ids (also works with a single university id)

Headers

Name	Value
Accept
Content-Type

GPACalculation (Advising GPA Calculator)

Show/Hide
List Operations
Expand Operations
Raw

PUT /auth/advising/gpa-calculator/save-cloud-file

Save a PDF of a GPA Calculation

Parameters

Parameter	Value	Parameter Type	Description
dto		body	Request a GPA calculation

Headers

Name	Value
Accept
Content-Type

PUT /auth/advising/gpa-calculator/calculate

GPA Calculation results

Parameters

Parameter	Value	Parameter Type	Description
dto		body	Request a GPA calculation

Headers

Name	Value
Accept
Content-Type

POST /auth/advising/gpa-calculator/delete-cloud-file

Delete a PDF of a GPA Calculation

Parameters

Parameter	Value	Parameter Type	Description
fileUUID		query	Delete a PDF of a GPA calculation

Headers

Name	Value
Accept
Content-Type

GPACalculationCloudFile (Operations about Student Note Files)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/advising/gpa-calculation-files/{uid:/d+}/{id:/d+}

Get student file by student and id

Implementation Notes

This will return a given file for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student
id		path	The ID of the student file

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/gpa-calculation-files/{uid:/d+}

Get student files by student

Implementation Notes

This will return a list of shared files for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student

Headers

Name	Value
Accept
Content-Type

GenericComm (Financial Aid services for sending grouped communications via Dispatch)

Show/Hide
List Operations
Expand Operations
Raw

GenericParentComm (Financial Aid services for sending grouped communications via Dispatch)

Show/Hide
List Operations
Expand Operations
Raw

GradeWorkflowList (Instructors for a session and workflow status)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/courses/gradeworkflowlist/{session}/{status}

Find Instructors by session, status

Implementation Notes

Session should be in legacy format (i.e. 20128) Status of grade workflow in format (i.e. NO_STATUS, SAVED, SUBMITTED_SUPERVISOR, SUBMITTED, APPROVED, FINAL)

Parameters

Parameter	Value	Parameter Type	Description
session		path	The session you want to search in (legacy code)
status		path	The grade workflow status

Headers

Name	Value
Accept
Content-Type

GET /auth/registrar/courses/gradeworkflowlist/{session}

Find Instructors teaching multiple sections by session

Implementation Notes

Session should be in legacy format (i.e. 20128)

Parameters

Parameter	Value	Parameter Type	Description
session		path	The session you want to search in (legacy code)

Headers

Name	Value
Accept
Content-Type

GET /auth/registrar/courses/gradeworkflowlist/independentStudyInstructorsNoAttend/{session}

Find Independent Study Instructors did not report attendance by session

Implementation Notes

Session should be in legacy format (i.e. 20128)

Parameters

Parameter	Value	Parameter Type	Description
session		path	The session you want to search in (legacy code)

Headers

Name	Value
Accept
Content-Type

GradesDueWorkflowList (Instructors for a session and grades due)

Show/Hide
List Operations
Expand Operations
Raw

GraduateExam (Graduate Exam Web Service)

Show/Hide
List Operations
Expand Operations
Raw

GraduateExamPub (Graduate Exam Public Web Service)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/academic/gradExam/decisions

Get all decision options

Parameters

Parameter	Value	Parameter Type	Description
pos_exam_type		query
form_type		query

Headers

Name	Value
Accept
Content-Type

GroupAppointment (Operations about Student Advising Group Appointments)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/advising/group-appointments/{id:/d+}/{studentUid:/d+}

Get group meeting details

Implementation Notes

This will return detailed group meeting information

Parameters

Parameter	Value	Parameter Type	Description
id		path	The group meeting ID
studentUid		path	The university ID of the student

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/group-appointments/{uid:/d+}/today

Get today's group appointments by student

Implementation Notes

This will return a list of today's scheduled group appointments for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/group-appointments/{uid:/d+}/past

Get past group meetings by student

Implementation Notes

This will return a list of past group meetings for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/group-appointments/{uid:/d+}/attending/{meetingType}

Get attending group meetings by student and meeting type

Implementation Notes

This will return a list of attending group meetings for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student
meetingType		path	The meeting type to filter group meetings results

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/group-appointments/{uid:/d+}/upcoming

Get upcoming group meetings by student

Implementation Notes

This will return a list of upcoming group meetings for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/group-appointments/{uid:/d+}/{studentUid:/d+}/available

Get available group meetings by advisor

Implementation Notes

This will return a list of available group meetings offered by an advisor

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the advisor
studentUid		path	The university ID of the student

Headers

Name	Value
Accept
Content-Type

POST /auth/advising/group-appointments/search/upcoming

Searches and gets group meetings for the provided search criteria

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/group-appointments/categories

Get available group appointment category lookups

Implementation Notes

This will return a list of group appointment categories

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/group-appointments/categories/{appointmentType}

Get available group appointment category lookups using the type of appointment

Implementation Notes

This will return a list of group appointment categories

Parameters

Parameter	Value	Parameter Type	Description
appointmentType		path	The type of appointment

Headers

Name	Value
Accept
Content-Type

DELETE /auth/advising/group-appointments/{id:/d+}/{uid:/d+}/leave

Leave a group meeting

Parameters

Parameter	Value	Parameter Type	Description
id		path	The group meeting ID
uid		path	The university ID of the student

Headers

Name	Value
Accept
Content-Type

PUT /auth/advising/group-appointments/{id:/d+}/{uid:/d+}/join

Join a group meeting

Parameters

Parameter	Value	Parameter Type	Description
id		path	The group meeting ID
uid		path	The university ID of the student

Headers

Name	Value
Accept
Content-Type

Hawkid (Hawkid Endpoints for DNA Services)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/dna/hawkid/med-students

Returns a list of People who are med students and need hawkids assigned.

Implementation Notes

Medical students don't get hawkids assigned in the normal way (special snowflakes), so the DNA team has a process for automatically creating hawkids for this population and sending them to them. This returns that population to DNA so they can do their processing.

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

HopeTax (Operations for fetching Hope Tax Info)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/billing/hopetax/1098/{id}/{year}/{format}

Fetches a 1098 form by Id

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a ubill for
year	path	The year for the 1098 requester
format	path	The format for the 1098

Headers

Name	Value
Accept
Content-Type

HopeTaxFormEmail (The HopeTaxFormEmailService provides service end-points to manage emails through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

HopeTaxFormPrint (The HopeTaxFormPrintService provides service end-points to produce IRS Form 1098-T forms through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

HopeTaxNoSsn (The HopeTaxNoSsnService provides service end-points to manage letters through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

HopeTaxNoSsnEmail (The HopeTaxNoSsnEmailService provides service end-points to manage emails through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

HopeTaxSsnNeededEmail (The HopeTaxSsnNeededEmailService provides service end-points to manage emails through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

ISIRNotification (Financial Aid services for sending ISIR based communications to Dispatch)

Show/Hide
List Operations
Expand Operations
Raw

IdCardCharge (Supports HRSS functions by allowing employees to opt in or out of the automatic payroll deduct option)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/billing/cardcharge/{id}

Fetches employee's current option (in or out)

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id for the employee

Headers

Name	Value
Accept
Content-Type

GET /auth/billing/cardcharge/{id}/{option}

Updates employee's option

Parameters

Parameter	Value	Parameter Type	Description
id		path
option		path

Headers

Name	Value
Accept
Content-Type

InactiveCourse (Inactive Course Resources)

Show/Hide
List Operations
Expand Operations
Raw

IncoPastDueLetter (The IncoPastDueLetterService provides service end-points to manage InCo Past Due letters through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

IncoUnprocessedAccounts (Provide email address support to Dispatch for unprocessed InCo accounts opened last month.)

Show/Hide
List Operations
Expand Operations
Raw

InstructorRole (Instructor Sections taught read operations)

Show/Hide
List Operations
Expand Operations
Raw

InstructorSections (Instructor Sections taught read operations)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/instructor/{id}/{hawkId}

Find a session by it's legacy code

Parameters

Parameter	Parameter Type	Description
id	path	The legacy code of the session (e.g. 20128...)
hawkId	path	The hawk id of the instructor
includeHistory	query	Whether or not to include instructor assignment history

Headers

Name	Value
Accept
Content-Type

InternationalStudentTaxWithholding (Get Intl Student Tax Withholding e-mail population for Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

IsisNews (Basic services to retrieve messages for ISIS)

Show/Hide
List Operations
Expand Operations
Raw

LoanConfirmation (Financial Aid Loan Confirmation Services)

Show/Hide
List Operations
Expand Operations
Raw

Lookup (Operations about lookups)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/lookups/session-date/{id:[/d]+}

Find session date lookup by internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the session date lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/states/{naturalKey}

Find state lookup by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the state lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/address-types

Find all address type lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/address-types/{naturalKey}

Find address lookup by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/pronouns/{naturalKey}

Find pronoun lookup by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/name-types

Find all name type lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/name-types/{naturalKey}

Find name type lookup by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/gender

Find all gender identity lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/gender/{naturalKey}

Find gender identity lookup by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/gender/{id:[/d]+}

Find gender identity lookup by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the gender identity lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/exam-materials

Find all exam material types with optional control filters

Parameters

Parameter	Value	Parameter Type	Description
deliveryMethod		query
examMedium		query

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/exam-materials/{id: /d+}

Find exam material type by id

Parameters

Parameter	Value	Parameter Type	Description
id		path

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/geneds

Find all general education lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/coursesubjects

Find all course subjects

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/coursesubjects/{naturalKey}

Find course subject lookup by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the course subject lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/coursesubjects/itch/{legacyItchDept}

Find course subject lookup by natural key

Implementation Notes

There may be more than one course subject for an itch department so only the first value is returned

Parameters

Parameter	Value	Parameter Type	Description
legacyItchDept		path	The natural key of the course subject lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/coursesubjects/{id: [/d]+}

Find course subject lookup by internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the course subject lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/states/{id:[/d]+}

Find state lookup by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the state lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/pronouns

Find all pronoun lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/states

Find all state lookups

Parameters

Parameter	Value	Parameter Type	Description
view		query	The view to use for fetching states

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/address-types/{id:[/d]+}

Find address lookup by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/course-levels

Find all course levels

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/course-group-types

Find all course group types

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/course-group-types/{natKey}

Find course group type by natural key

Parameters

Parameter	Value	Parameter Type	Description
natKey		path

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/course-group-sub-types

Find all course group sub-types

Parameters

Parameter	Value	Parameter Type	Description
containing-type-natural-key		query

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/course-group-sub-types/{natKey}

Find course group sub-type by natural key

Parameters

Parameter	Value	Parameter Type	Description
natKey		path

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/waitlists

Find all wait list plans

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/waitlist

Find wait list plan for a provided query

Parameters

Parameter	Value	Parameter Type	Description
query		query	The query to use

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/section-types

Find all section types

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/section-types/{natkey}

Find section type by natural key

Parameters

Parameter	Value	Parameter Type	Description
natkey		path	The natural key of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/learning-types

Find all section learning types

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/levels-of-study

Find all section types

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/levels-of-study/{natkey}

Find level of study by natural key

Parameters

Parameter	Value	Parameter Type	Description
natkey		path	The natural key of the level of study

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/plan-mile-markers

Find all sample plan mile marker lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/plan-mile-markers/{id}

Find sample plan mile marker lookup by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the sample plan mile marker lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/countries

Find all countries for a provided view

Parameters

Parameter	Value	Parameter Type	Description
view		query	The view to use for fetching countries

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/countries/{id:[/d]+}

Find country by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the country to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/countries/{naturalKey}

Find country by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the country to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/countries/by-description/{description}

Find country by description

Parameters

Parameter	Value	Parameter Type	Description
description		path	The description of the country to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/counties

Find all counties or all counties for a given state

Implementation Notes

If nothing is provided for the view parameter then all counties will be retrieved

If 'forstate' is provided for the view parameter then you must provide a valid state natural key (i.e. IA,MN etc)

Parameters

Parameter	Value	Parameter Type	Description
view		query	The view to use
state		query	The natural key of the state to fetch counties for

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/counties/{id:[/d]+}

Find a county by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the county to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/counties/{naturalKey}

Find a county by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the county to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-international-visa-types

Find all visa types

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-international-visa-types/{id:[/d]+}

Find visa type by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the visa type to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-international-visa-types/{naturalKey}

Find visa type by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the visa type to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-industry-types

Find all industry types

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-industry-types/{id:[/d]+}

Find industry type by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the industry type to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-industry-types/{naturalKey}

Find industry type by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the industry type to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-external-degrees

Find all external degrees

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-external-degrees/{id:[/d]+}

Find external degree by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the external degree to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-external-degrees/{naturalKey}

Find external degree by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the external degree to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-international-sponsoring-agencies

Find all sponsoring agencies

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-international-sponsoring-agencies/{id:[/d]+}

Find sponsoring agency by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the sponsoring agency to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-international-sponsoring-agencies/{naturalKey}

Find sponsoring agency by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the sponsoring agency to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-ui-exchange-programs

Find all ui exchange programs

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application--ui-exchange-programs/{id:[/d]+}

Find ui exchange program by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the ui exchange program to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application--ui-exchange-programs/{naturalKey}

Find ui exchange program by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the ui exchange program to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/program-objective

Find degree objectives

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/program-objective/{naturalKey}

Find degree objective by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the degree objective to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/program-classifications

Find all degree classifications

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/program-classification/{naturalKey}

Find degree classification by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the degree classification to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/geneds/{naturalKey}/{naturalKeyPopulation}

Find gen ed by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the gen ed to fetch
naturalKeyPopulation		path	The natural key of the population to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/registrar/geneds/{id: /d+}/{naturalKeyPopulation}

Find gen ed by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the gen ed to fetch
naturalKeyPopulation		path	The natural key of the population to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-activities

Find application activity by view and/or type

Implementation Notes

If view is left blank all application activities are returned. If it is included it must be 'fortype' and then the type query parameter should also be included.

Parameters

Parameter	Value	Parameter Type	Description
view		query	The view of application activities to fetch. Leave blank for all and use 'fortype' to filter by type
type		query	The type of application activities to fetch. Use this parameter along with the 'view' parameter set to 'fortype' to filter by type

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-parent-ed-levels

Find all parent education levels

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-activities/{id:[/d]+}

Find application activity by internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the application activity to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-activities/{naturalKey}

Find application activity by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the application activity to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-test-types

Find all test types

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-test-types/{id:[/d]+}

Find test types by internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the test type to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-test-types/{naturalKey}

Find test types by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the test type to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-gre-subject-test-types

Find all GRE subject test types

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/application-all-test-score-ranges

Find all ranges for test scores

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/session-date/{naturalKey}

Find session date lookup by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the session date lookup to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/session-date

Find all session date lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/session-context/{id:[/d]+}

Find session context lookup by internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the session context lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/session-context/{naturalKey}

Find session date context by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the session context lookup to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/session-context/by-au/{naturalKey}

Find session date context by academic unit natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the session context lookup to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/session-context

Find all session context lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/relationships

Find all relationships for a provided view

Parameters

Parameter	Value	Parameter Type	Description
view		query	The view to use for fetching relationships

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/relationships/{id:[/d]+}

Find relationship by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the relationship to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/relationships/{naturalKey}

Find relationship by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the relationship to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/generations

Find all generations for a provided view

Parameters

Parameter	Value	Parameter Type	Description
view		query	The view to use for fetching generations

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/generations/{id:[/d]+}

Find generation by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the generation to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/generations/{naturalKey}

Find generation by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the generation to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/ethnicities

Find all ethnicities

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/ethnicities/{id:[/d]+}

Find ethnicity by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the ethnicity to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/ethnicities/{naturalKey}

Find ethnicity by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the ethnicity to fetch

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/carriers

Find all cell carriers

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/carriers/{key}

Find cell carrier by carrier enum or carrier label

Parameters

Parameter	Value	Parameter Type	Description
key		path

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/course-section-mode

Find all CourseSectionMode lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/course-section-mode/{naturalKey}

Find CourseSectionMode by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/facility-room

Find all FacilityBuildingRoom lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/facility-room/{naturalKey}

Find FacilityBuildingRoom lookups

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/facility-learning-center

Find all FacilityLearningCenter lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/facility-learning-center/{naturalKey}

Find FacilityLearningCenter lookups

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the address lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/facility-region

Find all FacilityRegion lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/course-category-types

Find all course category lookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/withdrawal-reason-types

Find all WithdrawalReasonTypeLookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/withdrawal-reasons

Find all WithdrawalReasonLookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/withdrawal-contacts

Find all WithdrawalContactLookups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/qualifiers

Find all QualifierLookup objects

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/appointment-reason/{naturalKey}

Find Appointment Reason by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the appointment reason

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/appointment-format/{naturalKey}

Find Appointment Format by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the appointment reason

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/orientation-tasks

Find all OrientationTaskLookup objects

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/orientation-fyo

Find all OrientationFirstYearOpportunityLookup objects

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/management-type-group

Find all management type groups

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/lookups/accommodation/{naturalKey}

Find accommodation lookup by natural key

Parameters

Parameter	Value	Parameter Type	Description
naturalKey		path	The natural key of the accommodation lookup

Headers

Name	Value
Accept
Content-Type

NIHForm (Integration point for workflow notifications/callbacks for NIH form)

Show/Hide
List Operations
Expand Operations
Raw

POST /auth/admissions/nih/callback

Set nih form data for application

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

OrientationRegistration (Web service for operations about orientation registration)

Show/Hide
List Operations
Expand Operations
Raw

PDParkingSanction (Endpoints to manage parking sactions emails/etc. through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

PastDueNotice (Find enrolled students whose billing accounts are past due (A/R + collection + delinquent loans).)

Show/Hide
List Operations
Expand Operations
Raw

Payment (Returns screens that allow users from MyUI and HRSS to set up payment plans to pay their U-Bill)

Show/Hide
List Operations
Expand Operations
Raw

POST /auth/billing/payment/billing-account/{id}/credit-card

Completes the transaction, save a payment plan and forwards the user to the external credit card system

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a page for
bankAccountId	query	The bank id making the payment
frequency	query	The frequency of the payment (ONE_TIME or RECURRING)
date	query	The start date of the payment
paymentType	query	The type of the payment (a balance or flat amount
method	query	The method of payment (CREDIT_CARD)
endDate	query	The end date of the payment
amount	query	The amount of the payment
proxyId	query	Optional proxy account ID
submissionTime	query	The time of the payment submission
email	query	Confirmation email to be sent

Headers

Name	Value
Accept
Content-Type

PUT /auth/billing/payment/billing-account/{id}/payment-plan/{planId}

Inactivate a payment plan by payment plan ID.

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a page for
planId	path	The payment plan ID you wish to delete
proxyId	query	Optional proxy account ID

Headers

Name	Value
Accept
Content-Type

GET /auth/billing/payment/billing-account/{id}/maintenance-page

Get the ACH bank maintenance page.

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal billing account id for the individual you would like a page for

Headers

Name	Value
Accept
Content-Type

GET /auth/billing/payment/billing-account/{id}/maintenance-page-confirm

Confirm new bank account.

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a page for
bank	query	The ABA number of the bank
accountNbr	query	The bank account number
name	query	The bank nickname
type	query	The bank type (CHECKING or SAVINGS)
refund	query	Is it a refund account

Headers

Name	Value
Accept
Content-Type

POST /auth/billing/payment/billing-account/{id}/maintenance-page-complete

Save a new bank account.

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a page for
bank	query	The ABA number of the bank
accountNbr	query	The bank account number
name	query	The bank nickname
type	query	The bank type (CHECKING or SAVINGS)
refund	query	Is it a refund account
rule	query	Is this an international bank

Headers

Name	Value
Accept
Content-Type

PUT /auth/billing/payment/billing-account/{id}/bank-account/{accountId}

Inactivate a bank account.

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal billing account id for the individual you would like a page for
accountId		path	The bank account to delete

Headers

Name	Value
Accept
Content-Type

POST /auth/billing/payment/billing-account/{id}/one

Completes a one-time payment transaction, sends a confirming email and writes a billing acount comment

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a page for
bank	query	The bank ABA number
account	query	The bank account number
accountType	query	The type of account (CHECKING or SAVINGS)
paymentType	query	The type of the payment (a balance or flat amount
amount	query	The amount of the payment
submissionTime	query	The time of the payment submission
email	query	Confirmation email to be sent

Headers

Name	Value
Accept
Content-Type

GET /auth/billing/payment/billing-account/{id}/entry-page

Returns the initial entry payment screen

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a page for
proxyId	query	The id of the proxy account if this is a proxy payment
key	query	A verification key for unauthenticated users

Headers

Name	Value
Accept
Content-Type

GET /auth/billing/payment/billing-account/{id}/confirmation-page

Returns the confirmation screen

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a page for
bankAccountId	query	The bank id making the payment
frequency	query	The frequency of the payment (ONE_TIME or RECURRING)
date	query	The start date of the payment
paymentType	query	The type of the payment (a balance or flat amount
method	query	The method of payment (ACH_DEDUCT, PAYROLL_DEDUCT or CREDI_CARD)
endDate	query	The end date of the payment
amount	query	The amount of the payment
proxyId	query	The id of the proxy account if this is a proxy payment

Headers

Name	Value
Accept
Content-Type

POST /auth/billing/payment/billing-account/{id}/completion-page

Completes the transaction, sends a confirming email and writes a billing acount comment

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a page for
bankAccountId	query	The bank id making the payment
frequency	query	The frequency of the payment (ONE_TIME or RECURRING)
date	query	The start date of the payment
paymentType	query	The type of the payment (a balance or flat amount
method	query	The method of payment (ACH_DEDUCT, PAYROLL_DEDUCT or CREDI_CARD)
endDate	query	The end date of the payment
amount	query	The amount of the payment
proxyId	query	Optional proxy account ID
submissionTime	query	The time of the payment submission
email	query	Confirmation email to be sent

Headers

Name	Value
Accept
Content-Type

Person (Person Endpoints for HR Services)

Show/Hide
List Operations
Expand Operations
Raw

Person (Operations about persons)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}

Find a person by the person key

Implementation Notes

The order of trying to find a person goes like this:

* If the input is numeric and length 8 and starts with '0' or '2344' we try uid

* If the input is numeric and not length 8 or 9 then we try Master id

* If the length is 16 and the first charcter is numeric then we try MRUID (Eds id)

* Otherwise we try hawkid

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}

Insert a person if it does not already exist for the key provided

Parameters

Parameter	Value	Parameter Type	Description
		body	The person resource you would like to create (Used to represent/create a person resource) Model Attributes id url firstName middleName lastName generation birthDate edsMruid edsActive hawkid univid ssn mfXrefid gender parkingAcctId vaultId isGuest isInstructor highSchool
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/{id: /d+}

Find an instructor by their internal instructor id

Implementation Notes

This is an artifact carried over from the now obsolete 'PersonWebService' by necessity.

This service is needed until we update the section services to include a master id for instructors instead of the course section instructor id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal instructor id
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/legacyFERPA

FERPA completion from the HR warehouse, not in ICON

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person (Person Endpoints for DNA Services)

Show/Hide
List Operations
Expand Operations
Raw

PUT /auth/dna/person/{univid}/attributes

Allows DNA to update certain attributes that flow through their services into MAUI (currently just birthDate, and vaultid)

Parameters

Parameter	Value	Parameter Type	Description
univid		path
		body	The atributesto update (Hold the keys that DNA provides to MAUI) Model Attributes birthDate vaultid

Headers

Name	Value
Accept
Content-Type

GET /auth/dna/person/search

Find active Person resources by name and birthDate

Implementation Notes

At least one parameter must be provided, parameters are ANDed together to find results that match *all* of the terms that you provide. Wildcards (*,?) are allowed in the name fields, but will impact performance. Searches are case-insensitive. Only the current standard name type is searched.This endpoint will only return a maximum of 200 results. If you receive 200 records, more might have matched.If your query didn't find any records, an empty JSON list will be returned (instead of a 404).

Parameters

Parameter	Parameter Type	Description
firstName	query	Wildcards (*?) allowed
middleName	query	Wildcards (*?) allowed
lastName	query	Wildcards (*?) allowed
birthDate	query	yyyy-mm-dd format, optional

Headers

Name	Value
Accept
Content-Type

GET /auth/dna/person/find

Find an active Person resource by alternative keys (univid, mruid, hawkid, vaultid)

Implementation Notes

Only provide a single query parameter, but you can lookup a Person by any of the following keys (univid, mruid, hawkid, vaultid)

Parameters

Parameter	Value	Parameter Type	Description
hawkid		query
univid		query
mruid		query
vaultid		query

Headers

Name	Value
Accept
Content-Type

GET /auth/dna/person/{univid}/dnakeys

Provides back keys provided by DNA services (mruid, hawkid, emailAlias)

Parameters

Parameter	Value	Parameter Type	Description
univid		path

Headers

Name	Value
Accept
Content-Type

PUT /auth/dna/person/{univid}/dnakeys

Update keys provided by DNA services after a collision has been resolved on the DNA side

Implementation Notes

We expect a non-null mruid, and nullable hawkid/emailAlias

Parameters

Parameter	Value	Parameter Type	Description
univid		path
		body	The DNA keys to update (Hold the keys that DNA provides to MAUI) Model Attributes mruid hawkid emailAlias emailTarget

Headers

Name	Value
Accept
Content-Type

POST /auth/dna/person

Insert a person in the MAUI database, performs dupe check and id creation along the way as appropriate

Implementation Notes

The lastName field is a required attribute, everything else is option but encouraged. This endpoint will create a univid/mruid on the Person it creates (even if it hits an exact match on an existing record with a null univid/mruid). If the Person created is in a dup set, it will create the univid in an inactive status, otherwise it will create an active univid and assign it to the person. If a birthDate is provided, it should be in yyyy-mm-dd format.

Parameters

Parameter	Parameter Type	Description
	body	The person resource you would like to create (Used to represent/create a MAUI Person (Guest)) Model Attributes masterId firstName middleName lastName birthDate mruid vaultid univid hawkid generation gender privateEmailAddress preferredPronouns preferredFirstName guestDept guestOrg guestTitle address phone
skipDummyAssign	query	should the dummy number assignment process be skipped, defaults to false
forceActivateUnivid	query

Headers

Name	Value
Accept
Content-Type

GET /auth/dna/person/{univid}/attributes

Allows DNA to fetch certain attributes that flow through their services into MAUI (currently just birthDate, and vaultid)

Parameters

Parameter	Value	Parameter Type	Description
univid		path

Headers

Name	Value
Accept
Content-Type

Person.Academic (Landing point for operations about academic data)

Show/Hide
List Operations
Expand Operations
Raw

Person.Academic.AcademicAdvisor (Returns student's program advisors and primary pos program college)

Show/Hide
List Operations
Expand Operations
Raw

Person.Academic.AcademicConsent (Update and list academic consent release information)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/academic/consent/list

Lists the academic consent releases provided by the student

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/academic/consent/update

Update academic consent release

Parameters

Parameter	Value	Parameter Type	Description
dto		body	The release dto to update from
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/academic/consent/save

Creates an academic consent release

Parameters

Parameter	Value	Parameter Type	Description
dto		body	The release dto to update from
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/consent/{id: /d+}

Fetch academic consent release by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the consent form
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Academic.AcademicEnrollmentChange (Operations about academics on registration changes)

Show/Hide
List Operations
Expand Operations
Raw

Person.Academic.AcademicEnrollments (Operations about academic enrollments)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/academic/enrollments/{academicEnrollmentId:/d+}

Find an enrollment by id

Parameters

Parameter	Value	Parameter Type	Description
academicEnrollmentId		path	The internal academic enrollment id of the enrollment you would like to fetch
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/enrollments/calendar/{sessionId:/d+}

Fetch all enrollments for a given session and student and put them into iCal format

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The internal session id that the student is signing the agreement for (i.e. 47 for Spring 2012, not 20118)
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/enrollments/final-exams/conflicts/{sessionId:/d+}

Fetch all final exam conflicts for a given session and student

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The internal session id (i.e. 47 for Spring 2012, not 20118)
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/academic/enrollments/set-honors-contract-pending/{academicEnrollmentID:/d+}

Update a current enrollment to pending for an honors notation

Parameters

Parameter	Value	Parameter Type	Description
academicEnrollmentID		path
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/academic/enrollments/update-via-admin-service/{academicEnrollmentId:/d+}

Update a current enrollment

Implementation Notes

Because this is looking for a json request body, this may be difficult to test on the documentation page

Parameters

Parameter	Parameter Type	Description
academicEnrollmentId	path	The internal enrollment id that represents the student's current enrollment
enrollment	body	The enrollment object representing the changes requested for the current enrollment. It should be sent as the request body in valid JSON format. (A POJO for managing enrollment data) Model Attributes courseIdentityId - (The internal id of the Course Identity (Required if not a Course Bundle)) sections - (The map of Course Section ids to Longs (Required if not a Course Bundle)) hours - (The hours to enroll for (Required if multiple choices exist)) instructorId - (The internal id of the instructor for an Independent Study (Required if Independent Study) coursesInCommonId - (The internal id of the Course Bundle (Required if a Course Bundle)) isEnrolledPassFail - (Enrolled pass fail flag)
statuses	query	Optional parameter to specify which statuses you care about
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

DELETE /auth/personsTEMP/{key}/academic/enrollments/{academicEnrollmentId:/d+}

Drop a current enrollment

Parameters

Parameter	Parameter Type	Description
academicEnrollmentId	path	The internal enrollment id that represents the student's current enrollment
statuses	query	Optional parameter to specify which statuses you care about
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

DELETE /auth/personsTEMP/{key}/academic/enrollments/dropAll/{sessionId:/d+}

Drops all courses

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The session ID of the drop
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

DELETE /auth/personsTEMP/{key}/academic/enrollments/withdraw/{sessionId:/d+}

Withdraws an entire registration

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The session ID of the withdrawal
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/enrollments/basic/all

Fetch all enrollments ever for a given student

Implementation Notes

This is one of the more public facing apis with mostly external data (non-primary key data)

Parameters

Parameter	Value	Parameter Type	Description
status		query	The status you want to filter the results by
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/enrollments/basic/{sessionCode: /d{5}}

Fetch all enrollments for a given session for a given student

Implementation Notes

This is one of the more public facing apis with mostly external data (non-primary key data)

Parameters

Parameter	Parameter Type	Description
sessionCode	path	The session code that the student is signing the agreement for (i.e. 20118 for Spring 2012, not 47)
status	query	The status you want to filter the results by
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/enrollments/by-session/{sessionId:/d+}

Fetch all enrollments for a given session and student

Parameters

Parameter	Parameter Type	Description
sessionId	path	The internal session id that the student is signing the agreement for (i.e. 47 for Spring 2012, not 20118)
statuses	query	Optional parameter to specify which statuses you care about
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/enrollments/final-exams/{sessionId:/d+}

Fetch all final exams for a given session and student

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The internal session id (i.e. 47 for Spring 2012, not 20118)
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/academic/enrollments/{sessionId:/d+}

Enroll a student in a course

Implementation Notes

Because this is looking for a json request body, this may be difficult to test on the documentation page

Parameters

Parameter	Parameter Type	Description
sessionId	path	The internal session id that the student is enrolling for (i.e. 47 for Spring 2012, not 20118)
enrollment	body	The enrollment object representing this enrollment. It should be sent as the request body in valid JSON format. (A POJO for managing enrollment data) Model Attributes courseIdentityId - (The internal id of the Course Identity (Required if not a Course Bundle)) sections - (The map of Course Section ids to Longs (Required if not a Course Bundle)) hours - (The hours to enroll for (Required if multiple choices exist)) instructorId - (The internal id of the instructor for an Independent Study (Required if Independent Study) coursesInCommonId - (The internal id of the Course Bundle (Required if a Course Bundle)) isEnrolledPassFail - (Enrolled pass fail flag)
statuses	query	Optional parameter to specify which statuses you care about
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/academic/enrollments/{academicEnrollmentId:/d+}

Update a current enrollment

Implementation Notes

Because this is looking for a json request body, this may be difficult to test on the documentation page

Parameters

Parameter	Parameter Type	Description
academicEnrollmentId	path	The internal enrollment id that represents the student's current enrollment
enrollment	body	The enrollment object representing the changes requested for the current enrollment. It should be sent as the request body in valid JSON format. (A POJO for managing enrollment data) Model Attributes courseIdentityId - (The internal id of the Course Identity (Required if not a Course Bundle)) sections - (The map of Course Section ids to Longs (Required if not a Course Bundle)) hours - (The hours to enroll for (Required if multiple choices exist)) instructorId - (The internal id of the instructor for an Independent Study (Required if Independent Study) coursesInCommonId - (The internal id of the Course Bundle (Required if a Course Bundle)) isEnrolledPassFail - (Enrolled pass fail flag)
statuses	query	Optional parameter to specify which statuses you care about
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Academic.AcademicGrades (Read operations about academic grades)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/academic/grades/{sessionId: /d+}

Fetch grades for an academic by session

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The internal session id you want to search on
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/grades/grade-report

Fetch the formatted grade report for a given student

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/grades/by-enrollment/{enrollmentId}

Fetch grades for an academic enrollment by enrollment id

Parameters

Parameter	Value	Parameter Type	Description
enrollmentId		path	The internal enrollment id you want to search on
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Academic.AcademicSession (Operations about academic sessions)

Show/Hide
List Operations
Expand Operations
Raw

Person.Academic.AcademicWaitlist (Operations about academics on waitlists)

Show/Hide
List Operations
Expand Operations
Raw

Person.Academic.HawkGrant (Operations about Hawk Grant)

Show/Hide
List Operations
Expand Operations
Raw

Person.Academic.Transcript (Operations about academic grades)

Show/Hide
List Operations
Expand Operations
Raw

POST /auth/personsTEMP/{key}/academic/transcripts/save-document

For the provided list of uuids, creates a master document record and then transcript order detail document record.

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/transcripts/check-holds

Check for any transcript holds

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/transcripts

Gets all transcript orders

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/academic/transcripts/{id:/d+}

Gets transcript order by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	Internal id of transcript order
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/academic/transcripts

Saves a new transcript order

Parameters

Parameter	Value	Parameter Type	Description
orderDTO		body	The transcript order dto to build from
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/academic/transcripts/validate-detail

Validates an order detail

Parameters

Parameter	Value	Parameter Type	Description
detailDTO		body	The order detail to validate
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Academic.WithdrawalSurvey (Withdrawal academic session api operations)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/academic/withdrawal/{sessionId}

Get a specific withdrawal for an academic session

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/academic/withdrawal/update

Update an existing withdrawal

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/academic/withdrawal/save

Saves a new withdrawal

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

DELETE /auth/personsTEMP/{key}/academic/withdrawal/delete/{id:/d+}

Delete an existing withdrawal

Parameters

Parameter	Value	Parameter Type	Description
id		path
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Attestation (Landing point for operations about attestations)

Show/Hide
List Operations
Expand Operations
Raw

Person.MasterDocument (Operations about master documents)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/documents/{documentId: /d+}

Fetch a document by id

Parameters

Parameter	Value	Parameter Type	Description
documentId		path
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/documents/{documentId: /d+}/download

Download a document by id

Parameters

Parameter	Value	Parameter Type	Description
documentId		path
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/documents

Upload a new document

Parameters

Parameter	Parameter Type	Description
fileName	query
typeAndOrgId	query
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/documents

Fetch info about all documents for a person (with possible filter)

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

DELETE /auth/personsTEMP/{key}/documents/{documentId: /d+}

Delete a document by id

Parameters

Parameter	Value	Parameter Type	Description
documentId		path
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.PersonAddress (Operations about addresses)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/addresses/{id}

Fetch an address resource of a person by the address id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the address resource
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/addresses

Insert an address resource into a person by address type

Parameters

Parameter	Parameter Type	Description
type	query	The natural key of the type of address you would like to create
updateunivid	query	The university id of the person making the change
justCleanse	query	A flag to indicate if you just want the address information cleansed and not persisted
	body	The new address resource
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/addresses

List all addresses for a person based on type and possibly the effective status

Parameters

Parameter	Parameter Type	Description
type	query	The natural key of the type of addresses you would like
effective	query	The effective status of the addresses you want
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/addresses/my-ui

List all addresses for a person based on type and possibly the effective status in different format than other address endpoint

Parameters

Parameter	Parameter Type	Description
type	query	The natural key of the type of addresses you would like
effective	query	The effective status of the addresses you want
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.PersonBio (Operations about person bios)

Show/Hide
List Operations
Expand Operations
Raw

PUT /auth/personsTEMP/{key}/bio

Update a person bio

Parameters

Parameter	Parameter Type	Description
updateunivid	query
	body
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/bio/pronouns

Allows direct access of pronouns and visibility

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PATCH /auth/personsTEMP/{key}/bio

Update a person bio

Parameters

Parameter	Parameter Type	Description
updateunivid	query
	body
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/bio

Find a person bio

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/bio/pronouns

Allows direct update of pronouns and visibility

Parameters

Parameter	Value	Parameter Type	Description
		body
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/bio/use-preferred-name-in-directory

Allows direct access of use preferred name in directory flag

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/bio/use-preferred-name-in-directory

Allows direct update of use preferred name in directory flag

Parameters

Parameter	Value	Parameter Type	Description
		body
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.PersonEmail (Operations about emails)

Show/Hide
List Operations
Expand Operations
Raw

POST /auth/personsTEMP/{key}/emails

Insert an email resource into a person by email type

Parameters

Parameter	Parameter Type	Description
type	query	The natural key of the type of email you would like to create
updateunivid	query	The university id of the person making the change
	body	The new email resource (Email resource model) Model Attributes id url email effectiveDate restricted deliverable emailLookupNaturalKey
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/emails/{id}

Fetch an email resource of a person by the email id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the email resource
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/emails

List all emails for a person based on type and possibly the effective status

Parameters

Parameter	Parameter Type	Description
type	query	The natural key of the type of emails you would like
effective	query	The effective status of the emails you want
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.PersonName (Operations about names)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/names/{id}

Find a name DTO by internal pk

Parameters

Parameter	Value	Parameter Type	Description
id		path
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/names

Lookup names for an individual by type

Parameters

Parameter	Parameter Type	Description
type	query	The name lookup type
effective	query	The effective view to pull from
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

DELETE /auth/personsTEMP/{key}/names/{id}

Delete a name by internal pk.

Parameters

Parameter	Parameter Type	Description
id	path
updateunivid	query	The university id of the user making the update
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/names/update

Update or create a person name

Parameters

Parameter	Value	Parameter Type	Description
		body
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/names

Create a name for an individual by type.

Parameters

Parameter	Parameter Type	Description
type	query	The name lookup type
updateunivid	query	The university id of the user making the update
	body
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.PersonRestrict (Operations about data restrictions (academic, directory, phone and address))

Show/Hide
List Operations
Expand Operations
Raw

POST /auth/personsTEMP/{key}/restrictions

Update the current restriction settings for a person

Implementation Notes

For the address and phone restrictions, only the residing address and phone are used

Parameters

Parameter	Value	Parameter Type	Description
restrictionDTO		body	The new restriction settings to apply to the person (A DTO to represent data restriction settings) Model Attributes directory - (Indicates whether or not a person is directory restricted) address - (Indicates whether or not a person has address restricted) phone - (Indicates whether or not a person has phone restricted) academic - (Indicates whether or not a person has an academic restrict)
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/restrictions

Get the current restriction settings for a person

Implementation Notes

For the address and phone restrictions, only the residing address and phone are used

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Student (Landing point for operations about student data)

Show/Hide
List Operations
Expand Operations
Raw

Person.Student.AcademicPlan (Operations on academic plans)

Show/Hide
List Operations
Expand Operations
Raw

Person.Student.AcademicPlan.MileMarker (Operations on individual mile markers in academic plans)

Show/Hide
List Operations
Expand Operations
Raw

Person.Student.StudentMessage (Operations about ISIS student messages)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/student/isis-messages/{id}

Find isis message by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the message you want
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/student/isis-messages/update

Update the read and deleted flags for a message. This service only updates these flags

Parameters

Parameter	Value	Parameter Type	Description
messageDTO		body	The isis student message dto to update from (Data elements representing an Isis Student message. Used when updating flags.) Model Attributes studentId universityId messageDate expirationDate messageType messageSubject message status id
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/student/isis-messages

Find isis messages for a student based on the filter

Parameters

Parameter	Value	Parameter Type	Description
filter		query	The filter you want to use
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Student.StudentMessage (Operations about ISIS student messages)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/student/messages/{id}

Find isis message by id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The id of the message you want
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/student/messages/update

Update the read and deleted flags for a message. This service only updates these flags

Parameters

Parameter	Value	Parameter Type	Description
messageDTO		body	The isis student message dto to update from (Data elements representing an Isis Student message. Used when updating flags.) Model Attributes studentId universityId messageDate expirationDate messageType messageSubject message status id
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/student/messages

Find isis messages for a student based on the filter

Parameters

Parameter	Value	Parameter Type	Description
filter		query	The filter you want to use
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Student.StudentNews (Student news endpoints)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/personsTEMP/{key}/student/news

Find student news for student

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.Student.StudentOrientation (Student orientation operations)

Show/Hide
List Operations
Expand Operations
Raw

Person.Student.StudentPlacementTest (Operations about student placement tests)

Show/Hide
List Operations
Expand Operations
Raw

Person.Student.StudentProgramOfStudy (Operations about a student's programs of study)

Show/Hide
List Operations
Expand Operations
Raw

Person.Student.StudentRegistrationHold (Operations about student registration holds)

Show/Hide
List Operations
Expand Operations
Raw

DELETE /auth/personsTEMP/{key}/student/registration-hold/{id: /d+}

Remove a hold for student by hold id

Implementation Notes

This does not delete the hold, but sets the status to REMOVED

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the hold
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/student/registration-hold/{id: /d+}

Fetch the hold by hold id for a student

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the hold
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/student/registration-hold/list

Fetch the list of all holds (inactive or active) for a student

Parameters

Parameter	Value	Parameter Type	Description
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PUT /auth/personsTEMP/{key}/student/registration-hold/{id: /d+}

Update a hold for student by hold id

Implementation Notes

This currently only lets you update the effective session

Parameters

Parameter	Parameter Type	Description
id	path	The internal id of the hold
session	query	The legacy session id you want to update the hold to (i.e. 20118). If this value is blank the current session is used
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

POST /auth/personsTEMP/{key}/student/registration-hold

Add a hold for student by hold natural key and legacy session code

Parameters

Parameter	Parameter Type	Description
hold	query	The natural key of the hold you want added
session	query	The legacy session id you want to add the hold to (i.e. 20118)
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

Person.UICampusAddress (Operations about UI campus addresses)

Show/Hide
List Operations
Expand Operations
Raw

POST /auth/personsTEMP/{key}/uicampusaddresses

Save a campus address by address type

Parameters

Parameter	Parameter Type	Description
type	query	The natural key of the type of address you would like to create
updateunivid	query	The university id of the person making the change
	body	The new address resource
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/uicampusaddresses/{id}

Fetch a campus address resource of a person by the address id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the address resource
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

GET /auth/personsTEMP/{key}/uicampusaddresses

List all campus addresses for a person based on type and possibly the effective status

Parameters

Parameter	Parameter Type	Description
type	query	The natural key of the type of addresses you would like
effective	query	The effective status of the addresses you want
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Headers

Name	Value
Accept
Content-Type

PrivateDonor (Endpoints for private scholarship services.)

Show/Hide
List Operations
Expand Operations
Raw

ProctoredExamAuth (Proctored exam information)

Show/Hide
List Operations
Expand Operations
Raw

ProctoredExamAuth.ExamComments (APIs that let you work with exam comments)

Show/Hide
List Operations
Expand Operations
Raw

ProctoredExamAuth.ExamDocuments (APIs that let you work with exam documents)

Show/Hide
List Operations
Expand Operations
Raw

ProctoredExamAuth.MasterBasedExams (APIs that let you find exams by possible attendees/examinees/students/etc)

Show/Hide
List Operations
Expand Operations
Raw

ProctoredExamDOE (Communication populations for proctored exams)

Show/Hide
List Operations
Expand Operations
Raw

ProctoredExamPub (Proctored exam information)

Show/Hide
List Operations
Expand Operations
Raw

ProgramOfStudy (Operations about programs of study)

Show/Hide
List Operations
Expand Operations
Raw

ProgramOfStudy.Program (Read operations about programs)

Show/Hide
List Operations
Expand Operations
Raw

ProgramOfStudy.SubProgram (Read operations about sub programs)

Show/Hide
List Operations
Expand Operations
Raw

ProgramOfStudyStudent (List of students for program of study)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/pgmstu/program/{session}/{pgm}/{obj}

Find students by session, program, objective

Implementation Notes

Session should be in legacy format (i.e. 20128) Program should be natural key (i.e. ART, ART_HISTORY) Objective should be natural key (i.e. BFA, MFA, BS)

Parameters

Parameter	Parameter Type	Description
session	path	The program session you search for (legacy code)
pgm	path	The program you search for (natural key)
obj	path	The objective you search for (natural key)

Headers

Name	Value
Accept
Content-Type

GET /auth/registrar/pgmstu/acadorg/{session}/{org}/{obj}

Find students by session, academic unit, objective

Implementation Notes

Session should be in legacy format (i.e. 20128) Academic unit should be natural key (i.e. ART, ACTG, BIOL) Objective should be natural key (i.e. BFA, MFA, BS)

Parameters

Parameter	Parameter Type	Description
session	path	The program session you search for (legacy code)
org	path	The academic unit you search for (natural key)
obj	path	The objective you search for (natural key)

Headers

Name	Value
Accept
Content-Type

Prospector (Web service for prospector app)

Show/Hide
List Operations
Expand Operations
Raw

PublicMasterDocument (Operations about master documents)

Show/Hide
List Operations
Expand Operations
Raw

PublicTuition (Read operations for the public facing tuition app)

Show/Hide
List Operations
Expand Operations
Raw

RefundAccount (Returns screen for MyUI users to set their billing bank refund account)

Show/Hide
List Operations
Expand Operations
Raw

ResidencyApplication (Operations for the Residency Application)

Show/Hide
List Operations
Expand Operations
Raw

SIMS (SIMS Building Information)

Show/Hide
List Operations
Expand Operations
Raw

SamplePlan (Web service for operations about sample plans)

Show/Hide
List Operations
Expand Operations
Raw

Scheduling (Endpoint to facilitate registration scheduling)

Show/Hide
List Operations
Expand Operations
Raw

ScholarshipAppeal (Scholarship Appeal integration point for Workflow callbacks and Dispatch notifications)

Show/Hide
List Operations
Expand Operations
Raw

ScholarshipAppealEmail (Scholarship Appeal integration point for Workflow callbacks and Dispatch notifications)

Show/Hide
List Operations
Expand Operations
Raw

ScholarshipConfirmation (Financial Aid Scholarship Services)

Show/Hide
List Operations
Expand Operations
Raw

ScholarshipResidencyChangeEmail (Integration point for Scholarship Residency Change Dispatch notifications)

Show/Hide
List Operations
Expand Operations
Raw

Session (Session read operations)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/sessions

Find all sessions

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/{id}

Find a session by it's internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the session (e.g. NOT 20118...)

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/my-ui/register

Find the sessions shown on the ISIS registration page

Implementation Notes

This is a very specific use case service that was designed mainly for ISIS consumption

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/legacy/{id}

Find a session by it's legacy code

Parameters

Parameter	Value	Parameter Type	Description
id		path	The legacy code of the session (e.g. 20118...)

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/{id}/sub-sessions

Find a session by it's internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the session (e.g. NOT 20118...)

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/current

Find current session

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/bounded

Find a list of sessions going back specified number and future number

Implementation Notes

Starts with current session and builds a list based on the values passed for previous and future sorted descending. Either value may be zero.

Parameters

Parameter	Value	Parameter Type	Description
previous		query	The number of session back from current session.
future		query	The number of sessions after current session.

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/sub-sessions/{id}

Find a session by it's internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the sub-session

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/by-date

Find the active session for a given date

Parameters

Parameter	Value	Parameter Type	Description
date		query	The date in one of the following formats: yyyy-MM-dd, yyyy.MM.dd, yyyy/MM/dd, MM/dd/yy, MM-dd-yy, MM.dd.yy, MM/dd/yyyy, MM-dd-yyyy, MM.dd.yyyy, dd-MMM-yy, dd-MMM-yyyy

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/{id}/next

Find the next session based on a given session's internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the session (e.g. NOT 20118...)

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/{id}/previous

Find the previous session based on a given session's internal id

Parameters

Parameter	Value	Parameter Type	Description
id		path	The internal id of the session (e.g. NOT 20118...)

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/my-ui/browse

Find the sessions shown on the ISIS course browse page

Implementation Notes

This is a very specific use case service that was designed mainly for ISIS consumption

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/my-ui/register/default

Find the default session shown on the ISIS registration page

Implementation Notes

This is a very specific use case service that was designed mainly for ISIS consumption

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/my-ui/browse/default

Find the default session shown on the ISIS course browse page

Implementation Notes

This is a very specific use case service that was designed mainly for [mobile] ISIS consumption

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/range

Find a list of sessions specified by a query

Implementation Notes

This is a very general purpose function to fetch a range of sections based on the input params.

Parameters

Parameter	Parameter Type	Description
from	query	The internal id of the session (e.g. NOT 20118...)
steps	query	The number of steps to take from the 'from' session. May be negative to go back
term	query	The session term enum value

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/admissions

Find all sessions valid for Admissions

Parameters

Parameter	Value	Parameter Type	Description

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/sessions/sample-plan/mile-marker/{samplePlanStartSessionId}/{mileMarkerYear}/{mileMarkerTerm}

Used by sample plans. Finds the session of a mile mile marker.

Parameters

Parameter	Value	Parameter Type	Description
samplePlanStartSessionId		path
mileMarkerYear		path
mileMarkerTerm		path

Headers

Name	Value
Accept
Content-Type

SessionAttributes (Get, insert or update billing account session attributes)

Show/Hide
List Operations
Expand Operations
Raw

SessionDate (Operations about session dates based on the academic calendar)

Show/Hide
List Operations
Expand Operations
Raw

GET /pub/registrar/session-dates/{sessionId}/{contextLookup}/{dateLookup}

Find a session date based on the context natural key, date lookup natural key and session

Implementation Notes

Session parameter can be legacy session code, internal id, or 'current'

Parameters

Parameter	Parameter Type	Description
sessionId	path	The internal session id, legacy session code or 'current'
contextLookup	path	The natural key of the context lookup
dateLookup	path	The natural key of the date lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/session-dates/by-subsession/{subSessionId}/{contextLookup}/{dateLookup}

Find a session date based on the session, sub-session, context natural key, and date lookup natural key

Parameters

Parameter	Parameter Type	Description
subSessionId	path	The sub-session ID
contextLookup	path	The natural key of the context lookup
dateLookup	path	The natural key of the date lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/session-dates/by-date-lu/{sessionId}/{dateLookup}

Find session dates based on the date lookup natural key and session

Implementation Notes

Session parameter can be legacy session code, internal id, or 'current'

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The internal session id, legacy session code or 'current'
dateLookup		path	The natural key of the date lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/session-dates/by-context-lu/{sessionId}/{contextLookup}

Find session dates based on the context lookup natural key and session

Implementation Notes

Session parameter can be legacy session code, internal id, or 'current'

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The internal session id, legacy session code or 'current'
contextLookup		path	The natural key of the context lookup

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/session-dates/is-holiday/{date: /d{4}-/d{2}-/d{2}}

Determine if a given date is a university holiday

Implementation Notes

This uses the standard format of yyy-MM-dd for date parsing

Parameters

Parameter	Value	Parameter Type	Description
date		path	The formatted date you want to check for holidays

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/session-dates/holidays/{sessionId}

Find holiday session dates for a given session

Implementation Notes

Session parameter can be legacy session code, internal id, or 'current'

Parameters

Parameter	Value	Parameter Type	Description
sessionId		path	The internal session id, legacy session code or 'current'

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/session-dates/upcoming

Find upcoming print dates

Parameters

Parameter	Value	Parameter Type	Description
look-forward		query
context		query

Headers

Name	Value
Accept
Content-Type

GET /pub/registrar/session-dates

Search session dates

Parameters

Parameter	Parameter Type	Description
context	query	The natural key of the calendar context you are interested in. (e.g. DEFAULT)
date	query	The natural key of the session date you are interested in. (e.g. ISISAVAIL)
dateCategory	query	The natural key of the date category you are interested in. (e.g. HOUSING_DINING)
sessionCode	query	The session code to search (20148 for example)
sessionId	query	The internal session id to search. Either this or sessionCode must be specified
fiveYearDate	query	Whether or not to include Five Year Date dates in results
printDate	query	Whether or not to include Print Date dates in results

Headers

Name	Value
Accept
Content-Type

SessionRegistrationHolds (Endpoints for retrieving student registration hold information for an academic session.)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/academic/holds/{session: /d{5}}

Returns a list of all students who had an academic session created for the provided session.

Parameters

Parameter	Parameter Type	Description
session	path	The legacy code of the Session (20118...)
excludeAcademicHolds	query	Flag to exclude academic holds
excludeOrientationRequired	query	Flag to exclude orientation required
excludeNoDayTimeAssigned	query	Flag to exclude students with no day/time assigned

Headers

Name	Value
Accept
Content-Type

ShimStudent (Student Health Information Management Maui Student Service)

Show/Hide
List Operations
Expand Operations
Raw

POST /auth/shim/{univid}/files/upload/{fileName}/{fileExtension}

Post Files from MyUI to a network directory for HCIS to pick up and process

Implementation Notes

Student Health wants students to upload a document and then OCR will scan it later.

Parameters

Parameter	Value	Parameter Type	Description
univid		path
fileName		path
fileExtension		path

Headers

Name	Value
Accept
Content-Type

POST /auth/shim/misc/covidFileRequest

Process a covid file request

Implementation Notes

The list of dtos should come in.

Parameters

Parameter	Value	Parameter Type	Description
body		form

Headers

Name	Value
Accept
Content-Type

GET /auth/shim/misc/{univid}/{sessionCode:/d+}

Fetch miscellaneous MAUI information for handing back to SHIM

Implementation Notes

SHIM needs other random data across MAUI on the student page for SHIM

Parameters

Parameter	Value	Parameter Type	Description
univid		path
sessionCode		path

Headers

Name	Value
Accept
Content-Type

GET /auth/shim/{univid}/{sessionCode:/d+}

Fetch Maui Student information on a specific session for handing back to SHIM

Implementation Notes

SHIM needs information from across Maui, so rather than call 4 services, here's one to do it all.

Parameters

Parameter	Value	Parameter Type	Description
univid		path
sessionCode		path

Headers

Name	Value
Accept
Content-Type

GET /auth/shim/misc/studentsInDorm/{session}

Fetch Maui Students information for determining vaccine info back in SHIM

Implementation Notes

SHIM needs information from across Maui regarding vaccine information.

Parameters

Parameter	Value	Parameter Type	Description
session		path

Headers

Name	Value
Accept
Content-Type

GET /auth/shim/{univid}

Fetch Maui Student information for handing back to SHIM

Implementation Notes

SHIM needs information from across Maui, so rather than call 4 services, here's one to do it all.

Parameters

Parameter	Value	Parameter Type	Description
univid		path

Headers

Name	Value
Accept
Content-Type

GET /auth/shim/misc/studentDemographics/{universityId}

Fetch Maui Students demo information for SHIM

Implementation Notes

SHIM needs information from across Maui regarding vaccine information.

Parameters

Parameter	Value	Parameter Type	Description
universityId		path

Headers

Name	Value
Accept
Content-Type

ShoppingSheetCloudFile (Service to get the shopping sheet pdfs stored in cloud server)

Show/Hide
List Operations
Expand Operations
Raw

StateTaxOffsetLetter (The StateTaxOffsetLetterService provides service end-points for the creation of State Tax Offset letters through Dispatch.)

Show/Hide
List Operations
Expand Operations
Raw

Student (Read a student's resource disbursement data for a specific session)

Show/Hide
List Operations
Expand Operations
Raw

StudentAgreementGeneratorAPI (Methods related to generating a student agreement HTML form from stored DB info.)

Show/Hide
List Operations
Expand Operations
Raw

StudentCohort (Student Cohort Web Service)

Show/Hide
List Operations
Expand Operations
Raw

StudentCommunication (Read resource disbursement problems)

Show/Hide
List Operations
Expand Operations
Raw

StudentDisabilityApplication (Student Disability Application Web Service)

Show/Hide
List Operations
Expand Operations
Raw

StudentNote (Operations about Student Notes)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/advising/notes/{uid:/d+}/{id:/d+}

Get student note by student and id

Implementation Notes

This will return a given note for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student
id		path	The ID of the student note

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/notes/{uid:/d+}

Get student notes by student

Implementation Notes

This will return a list of shared notes for a student.

Parameters

Parameter	Parameter Type	Description
uid	path	The university ID of the student
includeCloudFiles	query	Whether or not to include shared cloud files
startDate	query	The inclusive start date's milliseconds from epoch to find the notes
endDate	query	The inclusive end date's milliseconds from epoch to find the notes

Headers

Name	Value
Accept
Content-Type

StudentNoteCloudFile (Operations about Student Note Files)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/advising/files/{uid:/d+}/{id:/d+}

Get student file by student and id

Implementation Notes

This will return a given file for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student
id		path	The ID of the student file

Headers

Name	Value
Accept
Content-Type

GET /auth/advising/files/{uid:/d+}

Get student files by student

Implementation Notes

This will return a list of shared files for a student

Parameters

Parameter	Parameter Type	Description
uid	path	The university ID of the student
startDate	query	The inclusive start date's milliseconds from epoch to find the files
endDate	query	The inclusive end date's milliseconds from epoch to find the files

Headers

Name	Value
Accept
Content-Type

StudyAbroadAward (Study Abroad Award Creation Service)

Show/Hide
List Operations
Expand Operations
Raw

SummerApplication (Financial Aid Loan Confirmation Services)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/finaid/isis/awarding/summerApplication/application/{univId}/{awardYear}/{sessionId}

Retrieve a summer application dto for this person and session

Implementation Notes

This will return the result of whether someone is eligible. This method assumes the eligibility check has been called and there is an aid applicant year

Parameters

Parameter	Parameter Type	Description
univId	path	University Id of the student
awardYear	path	MAUI Financial Aid Award Year
sessionId	path	Session identifier in MAUI ( should be summer )

Headers

Name	Value
Accept
Content-Type

GET /auth/finaid/isis/awarding/summerApplication/checkEligibility/{univId}/{awardYear}/{sessionId}

Process a summer application eligibility check request made by the student

Implementation Notes

This will return the result of whether someone is eligible.

Parameters

Parameter	Parameter Type	Description
univId	path	University Id of the student
awardYear	path	MAUI Financial Aid Award Year
sessionId	path	Session identifier in MAUI ( should be summer )

Headers

Name	Value
Accept
Content-Type

POST /auth/finaid/isis/awarding/summerApplication/apply/{univId}/{sessionId}

Process a summer application request

Implementation Notes

The university should be in both the path and inside the summer application body. If there is a error

Parameters

Parameter	Parameter Type	Description
univId	path	University Id of the student
sessionId	path	Session identifier in MAUI
applicationRequestDTO	body	The summer application object representing this request. It should be sent as the request body in valid JSON format.

Headers

Name	Value
Accept
Content-Type

SupplementalGradAppData (Grad department supplemental admissions data services)

Show/Hide
List Operations
Expand Operations
Raw

SupplementalGradAppWorkflowData (Grad department supplemental admissions data services)

Show/Hide
List Operations
Expand Operations
Raw

TranscriptWorkflow (Transcript Callback Web Service)

Show/Hide
List Operations
Expand Operations
Raw

TuitionFees (Read operations about different tuition fees)

Show/Hide
List Operations
Expand Operations
Raw

UBill (Operations for fetching U-Bills)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/billing/ubill/billing-account/{id}

Fetches a current U-Bill by Billable Account Id and date

Implementation Notes

This also has a parameter for specifying the format you would like the report in

Parameters

Parameter	Parameter Type	Description
id	path	The internal billing account id for the individual you would like a ubill for
date	query	The date you would like the ubill for. No date means current.
format	query	The format you would like the ubill to be in
key	query	Optional key to identify one-time payers

Headers

Name	Value
Accept
Content-Type

UBillBatchPrintAuth (Provide U-bill Print Data to Dispatch (authenticated methods))

Show/Hide
List Operations
Expand Operations
Raw

UBillBatchPrintPub (Provide U-bill Print Data to Dispatch (public methods))

Show/Hide
List Operations
Expand Operations
Raw

UBillEmail (Provide U-bill email addresses to Dispatch)

Show/Hide
List Operations
Expand Operations
Raw

UiWorkflow (UI Workflow Maui Web Services)

Show/Hide
List Operations
Expand Operations
Raw

UniversalWorkflow (Universal Workflow Maui Web Services)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/workflow/{univid}

Fetch the user's queued (inbox) forms (slips)

Implementation Notes

Universal workflow needs the live inbox forms and this service provides all the required information

Parameters

Parameter	Value	Parameter Type	Description
univid		path

Headers

Name	Value
Accept
Content-Type

GET /auth/workflow/{univid}/count

Count the user's queued (inbox) forms (slips)

Implementation Notes

Universal workflow needs the count of the live inbox forms and this service provides all the required information

Parameters

Parameter	Value	Parameter Type	Description
univid		path

Headers

Name	Value
Accept
Content-Type

GET /auth/workflow/{routingSlipId}/comments

Fetch the comments on a slip

Implementation Notes

Universal workflow needs the live comments on a form and this service provides them

Parameters

Parameter	Value	Parameter Type	Description
routingSlipId		path

Headers

Name	Value
Accept
Content-Type

GET /auth/workflow/{routingSlipId}/routing

Fetch the history of the routing on a slip

Implementation Notes

Universal workflow needs this information

Parameters

Parameter	Value	Parameter Type	Description
routingSlipId		path

Headers

Name	Value
Accept
Content-Type

GET /auth/workflow/delta

Create the delta feed for Universal Workflow since the given date

Implementation Notes

Universal workflow needs this delta feed on a nightly basis

Parameters

Parameter	Value	Parameter Type	Description
date		query
toDate		query

Headers

Name	Value
Accept
Content-Type

GET /auth/workflow/delta/{universityId}

Create the delta feed for Universal Workflow since the given date for the given person

Implementation Notes

Universal workflow needs this delta feed

Parameters

Parameter	Value	Parameter Type	Description
universityId		path
date		query
toDate		query

Headers

Name	Value
Accept
Content-Type

Verification (Operations about Student Record Verifications)

Show/Hide
List Operations
Expand Operations
Raw

GET /auth/registrar/verification/{uid}

Get student record verification by student

Implementation Notes

This will return a record verification for a student

Parameters

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student requesting the verification
verificationDTO		query	The verification dto to use to create a verification (Data elements needed to create a student record verification in MAUI via ISIS.) Model Attributes loanDeferment semesterGpaSessionLegacyCode gradesSessionLegacyCode enrollmentStatus enrollmentStartSessionLegacyCode enrollmentEndSessionLegacyCode isVoterResidency anticipatedGraduation schoolCode attendanceDates attendanceStartSessionLegacyCode attendanceEndSessionLegacyCode college programOfStudy classification awardsEarned enrolledHours classSchedule gradesTuition classScheduleTuition cumulativeHours uiGpa semesterGpa latestAddress scores birthdate academicStanding recentAcademicStandingSession residentStatus tuition enrolledHoursStartLegacyCode enrolledHoursEndLegacyCode enrolledHoursValues classScheduleSessionStartLegacyCode classScheduleSessionEndLegacyCode deliveryEnglish thirdPartyForms notOnlineInstitutionStatement

Headers

Name	Value
Accept
Content-Type

W9 (Allow SSN update for W9 purposes.)

Show/Hide
List Operations
Expand Operations
Raw

PUT /auth/billing/w9/{id}/{value}

Updates student's SSN

Parameters

Parameter	Value	Parameter Type	Description
id		path
value		path

Headers

Name	Value
Accept
Content-Type

WLPathways (Operations about WL Pathways)

Show/Hide
List Operations
Expand Operations
Raw

Parameter	Value	Parameter Type	Description
uid		path	The university ID of the student
meetingUid		path	The appointment unique ID

Parameter	Parameter Type	Description
uid	path	The university ID of the administrator
startDate	query
endDate	query

Parameter	Parameter Type	Description
appointmentType	path	The appointment type
collegeId	query
univid	query

Parameter	Parameter Type	Description
advisorUniversityId	path	University ID
appointmentType	path	Appointment type
reasonId	path	The appointment reason lookup
startDate	query
endDate	query

Parameter	Parameter Type	Description
studentUniversityId	path	University ID
reasonId	path	The appointment reason lookup
startDate	query
endDate	query

Parameter	Parameter Type	Description
collegeId	path	The id of the college
reasonId	path	The appointment reason lookup
startDate	query
endDate	query

Parameter	Parameter Type	Description
uid	path	The university ID of the advisor/admin
appointmentType	path	The type of appointment
reasonId	query

Parameter	Parameter Type	Description
adminUnivId	path	The University ID of the appointment admin
appointmentType	path	The type of appointment
reasonId	query

Parameter	Parameter Type	Description
universityId	path	Student's University Id.
session	path	Target session.
assessmentId	path	Assessment identifier.

Parameter	Value	Parameter Type	Description
univId		path	UnivID of billing account owner
yearType		path	Type of year: Calendar or Academic

Parameter	Parameter Type	Description
docTypeName	path	Document type
idType	path	ID type (UnivID or billing account number)
id	path	UnivID or account number of billing account owner
systemName	path	Context Path of system sending the request without the leading '/'
userHawkID	path	HawkID of person requesting the document
sessionCode	path	Legacy Code of the academic session for the document
yearType	path	Type of year - Calendar or Academic
year	path	Chosen year for data retrieval

Parameter	Value	Parameter Type	Description
univid		path
collegeKey		path
sessionCode		path
currentProgramKeys		path

Parameter	Value	Parameter Type	Description
college_id		path	The id of the college
session_id		path	The id of the session

Parameter	Value	Parameter Type	Description
nk		path	The natural key of the course subject (i.e. CHEM)
sessionId		path	The internal id of the session (NOT 20118...)

Parameter	Value	Parameter Type	Description
id		path	The internal id of the course subject
sessionId		path	The internal id of the session (NOT 20118...)

Parameter	Value	Parameter Type	Description
useUG		query
useMasters		query
useDoctoral		query
useProfessional		query

Parameter	Value	Parameter Type	Description
billingAccountId		path
addressType		path
currentPopulationCountId		path

Parameter	Value	Parameter Type	Description
session		path	Legacy session code (e.g. 20118 or 20123)
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Value	Parameter Type	Description
enrollmentChangeId		path
key		path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
enrollmentId	path
newSection	query	Section ID for the new section that the student wishes to switch to
newCreditHours	query	Hours for that the student wishes to switch to
isEnrolledPassFail	query	Pass/Fail grading option the student wishes to switch to
instructorId	query	Instructor Id for 0IND section changes
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Web Service Documentation

GET /pub/documentation/all

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

GET /pub/documentation/resource

Implementation Notes

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

GET /pub/documentation/api

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

GET /auth/registrar/enrollments/{sessionId:[/d]+}/{academicId}

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

GET /auth/registrar/enrollments/{academicEnrollmentId:[/d]+}

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

GET /auth/offices/sync

Implementation Notes

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

GET /auth/finaid/isis/monitoring/academicProgress/{univid}

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

POST /auth/finaid/isis/monitoring/academicProgress/appeal/{univid}

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

POST /auth/finaid/monitoring/academicProgress/appeal/routing/complete

Parameters

Headers

Request URL

Set Request Headers

Response Body

Response Code

Response Headers

POST /auth/finaid/monitoring/academicProgress/appeal/routing/advising

Parameters

Headers

Request URL

Set Request Headers

Parameter	Parameter Type	Description
sessionId	path
buildEnrollmentChangeIfNotFound	path
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
session	query	Session for which enrollment change was created
instructor	query	The instructor whose course section the student wishes to request an add for
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
sectionId	path
instructorUnivId	path
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
courseSectionId	path	The course section ID
changeType	path	The type of enrollment activity
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
sessionCode	path	The legacy session code
courseIdentifier	path	The SUBJ:CRSE of the Course
status	path	The status of the package
permissionType	query
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
permissionId	path	The internal id of the prerequisite special permission
status	path	The status of the package
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
courseIdentityId	path	The internal id of the Course Identity
sectionId	path	The internal id of the Course Section
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
attestationType	path	Attestation type
keyValueLookupKey	path	Attestation key-value lookup
keyValue	query	Attestation key-value
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
attestationType	path
forceExternalCheck	query
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id

Parameter	Parameter Type	Description
advisorIdentifier	path	The advisor identifier. Will work with univ id, hawk id, college name
programKey	path
sp	query
key	path	The identifier for the person. Can be hawkid, MRUID (Eds id), uid or internal Master id