Integration via Ellucian Ethos (Recommended)

Prev Next

Banner provides an extensive selection of APIs to enable seamless integrations with third-party systems. These APIs allow external systems to communicate effectively with Banner, promoting efficient data exchange and enhancements in functionality.

This section provides an overview of the APIs used within the TCE solution process, outlining their purposes, functions, and contributions to the overall system integration.

Authentication

The following settings and credentials are required to access and utilize the Banner API. These credentials ensure secure and authorized interaction with the API, enabling seamless data exchange and integration with ProcessMaker TCE.

Parameter

Description

Server URL

The regional server URL. Typically one of the following or a custom URL:

API Token

ProcessMaker integration components utilize the Ellucian Ethos API token to retrieve the JWT token used for API authentication.

Please refer to your Ellucian Banner/Ethos administrator to gather the above information.

Required APIs

This section lists all APIs utilized by ProcessMaker’s TCE solution. Please confirm that the API Token provides access to all API endpoints listed below.

Student Management

Method

Endpoint

Purpose

GET

/api/students

Retrieve a list of students by specific criteria (for example, Student Type).

GET

/api/students/{id}

Retrieve a student's details by Banner ID.

GET

/api/persons

Retrieve person entities by specific criteria.

GET

/api/persons/{id}

Retrieve a person's details by Banner ID.

GET

/api/student-types

Retrieve student types registered in Banner.

GET

/api/student-classifications

Retrieve student classifications registered in Banner.

GET

/api/academic-levels

Retrieve academic levels registered in Banner.

GET

/api/administrative-periods

Retrieve administrative periods registered in Banner.

Course Management

Method

Endpoint

Purpose

GET

/api/courses

Retrieve courses based on search criteria.

GET

/api/course-statuses

Retrieve course statuses registered in Banner.

GET

/api/subjects

Retrieve subjects based on search criteria.

GET

/api/subjects/{id}

Retrieve the subject related to a particular course.

GET

/api/course-title-types

Retrieve course title types registered in Banner.

Course Equivalency

Method

Endpoint

Purpose

GET

/api/level-codes

Retrieve a student's level codes.

GET

/api/source-background-institution-codes

Retrieve codes assigned to an external institution.

POST

/qapi/transfer-course-articulation

Retrieve source equivalency information.

Course Articulation

Method

Endpoint

Purpose

GET

/api/term-codes

Retrieve term codes.

GET

/api/transfer-institution-number

Evaluate whether a transfer institution number is registered for a student.

GET

/api/transfer-attendance-period

Evaluate whether an attendance period is registered for a student.

POST

/api/transfer-maintenance

Register a transfer institution and attendance period when missing.

POST

/qapi/transfer-course-detail-maintenance

Determine whether an articulation exists for an external course and student.

POST

/qapi/transfer-equivalent-course-maintenance

Determine whether an articulation exists for an internal course and student.

POST

/api/transfer-course-detail-maintenance

Register an articulation for an external course and student.

POST

/api/transfer-equivalent-course-maintenance

Register an articulation for an internal course and student.


Checklist

The following checklist includes all information and actions required to set up the ProcessMaker TCE and Ellucian Banner integration.

Option A — Ellucian Banner with Ethos

☐ Provide Ethos (Banner) API Token — Required to retrieve an API/user-specific JWT token.

☐ Provide API/Server URL — Regional or custom API URL.

☐ Ensure the API Token provides access to all required endpoints listed in this document.

Please refer to your Ellucian Banner/Ethos administrator to gather the above information.

SSO (Optional)

The required SSO parameters depend on the identity provider being used. Refer to the ProcessMaker SSO documentation:

https://docs.processmaker.com/docs/sso-settings

The documentation includes configuration guides for the following providers: