Integration via Ellucian Ethos (Recommended)

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 will give a thorough overview of all the APIs used within the TCE solution process, outlining their purposes, functions, and contributions to the overall system integration.

Authentication

The following settings/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 third-party systems (here, ProcessMaker TCE).

Server URL	The regional server URL. Typically, one of the following or a custom URL: https://integrate.elluciancloud.com — Ethos Integration API U.S. https://integrate.elluciancloud.ca — Ethos Integration API Canada https://integrate.elluciancloud.ie — Ethos Integration API Europe https://integrate.elluciancloud.com.au — Ethos Integration API Asia-Pacific Custom URL
API Token	ProcessMaker's integration components utilize the Ellucian Ethos API token to retrieve the JWT token that facilitates 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 the API endpoints below.

Student Management

Method/Type	Endpoint	Purpose
GET	/api/students	Retrieve a list of students by specific criteria (e.g., Student Type)
GET	/api/students/{id}	Retrieve a student’s details by Banner ID
GET	/api/persons	Retrieve a list of person entities by specific criteria (e.g. Banner ID)
GET	/api/persons/{id}	Retrieve a person’s details by Banner ID
GET	/api/student-types	Retrieve the list of student types registered in Banner
GET	/api/student-classifications	Retrieve the list of student classifications registered in Banner
GET	/api/academic-levels	Retrieve the list of academic levels registered in Banner
GET	/api/administrative-periods	Retrieve the list of administrative periods registered in Banner

Course Management

Method/Type	Endpoint	Purpose
GET	/api/courses	Retrieve a list of courses based on search criteria (e.g., course title)
GET	/api/course-statuses	Retrieve the list of course statuses registered in Banner
GET	/api/subjects	Retrieve a list of subjects based on search criteria (e.g., abbreviation)
GET	/api/subjects/{id}	Retrieve the subject related to a particular course
GET	/api/course-title-types	Retrieve the list of course statuses registered in Banner

Course Equivalency

Method/Type	Endpoint	Purpose
GET	/api/level-codes	Retrieve a list of a student’s level codes
GET	/api/source-background-institution-codes	Retrieve codes assigned to an external institution
POST	/qapi/transfer-course-articulation	Retrieve the source equivalency

Course Articulation

Method/Type	Endpoint	Purpose
GET	/api/term-codes	Retrieve the list of codes related to a particular term
GET	/api/transfer-institution-number	Evaluate if the transfer institution number is registered for a particular student
GET	/api/transfer-attendance-period	Evaluate if the attendance period is registered for a particular student
POST	/api/transfer-maintenance	Register a record when the transfer institution and the attendance period are not registered for a particular user
POST	/qapi/transfer-course-detail-maintenance	Evaluate if there is an existing articulation for a particular external course and student
POST	/qapi/transfer-equivalent-course-maintenance	Evaluate if there is an existing articulation for a particular internal course and student
POST	/api/transfer-course-detail-maintenance	Register an articulation for a particular external course and student
POST	/api/transfer-equivalent-course-maintenance	Register an articulation for a particular internal course and student

Checklist

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

Option A — Ellucian Banner with Ethos

• Provide Ethos (Banner) API Token — The API token is required to retrieve an API/user-specific JWT token.

• Provide API/Server URL — The region-specific 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 highly on the single sign-on provider used. Please refer to the ProcessMaker online documentation for SSO at https://docs.processmaker.com/docs/sso-settings.

The online documentation contains a section for all relevant services:

• Atlassian → https://docs.processmaker.com/v1/docs/sso-atlassian-settings

• Auth0 → https://docs.processmaker.com/v1/docs/sso-auth0-settings

• Facebook → https://docs.processmaker.com/v1/docs/sso-facebook-settings

• GitHub → https://docs.processmaker.com/v1/docs/sso-github-settings

• Google → https://docs.processmaker.com/v1/docs/sso-google-settings

• Keycloak → https://docs.processmaker.com/v1/docs/sso-keycloak-settings

• Microsoft → https://docs.processmaker.com/v1/docs/sso-microsoft-settings

• SAML → https://docs.processmaker.com/v1/docs/sso-saml-settings