The Astra Apps integration for Ellucian Ethos requires access to a collection of Data Access Models and endpoints.
Ad Astra will require an Ethos API Key. If Ellucian is hosting your Ethos instance, you'll have a standard URL (https://integrate.elluciancloud.com) otherwise Ad Astra will need the URL to your hosted instance.
- Essential Scheduling requires access to the Base Data below.
- Student Centered Scheduling and Integrated Planning require access to the Extended Data below.
- Ellucian supports using parameters to limit the data served via Ethos
- Here is the documentation for Colleague
- Check back here soon for Banner documentation
Verify Ethos Readiness
Ad Astra created a tool to help validate that your Ethos API Key has the necessary access for a successful Ad Astra integration.
- Configure the Data Access Models and Endpoints as specified in the tables below for the products you are integrating
- Access the tool here: https://app.adastra.live/readiness/
- Select which product you are integrating (Essential Scheduling or Student-Centered Scheduling)
- Select your SIS (Banner or Colleague)
- Submit the Ethos API key you have created for Ad Astra to use
The tool tests the key on the Ethos endpoints needed for your solution, then displays which responses are valid or invalid. With that information, you can clean up data or grant access to those endpoints as needed.
Your Ellucian Customer Service Manager can help with Ethos configuration or cleaning up data, if necessary.
Note: This tool does not expose your API Token or any data to Ad Astra. Data is only exchanged between your browser and Ellucian API endpoints.
Data Access
See Ellucian documentation for Ethos Data Access Configuration.
Banner Configuration | Colleague Configuration
Ellucian's tool for viewing Data Access: https://dataaccess-admin.elluciancloud.com (If you need access the tool and your Ellucian user does not have access, please contact Ellucian)
The only resources to add for GraphQL are those in the Data Access lists.
API permissions are still required in addition to data access models.
(**): Indicator of required Ethos endpoint for transforms to complete and the platform data to be populated.
Base Data Access Models for Essential Scheduling
| Name | Banner Version | Colleague Version |
| persons | 12 | 12 |
| sections** | 16 | 16 |
| section-registrations** | 16 | 16 |
|
section-instructors
|
10 | 10 |
| instructional-events** | 8 and 11 | 11 |
| courses** | 16 | 16 |
| rooms | 10 | 15 |
| employees | 12 | 12 |
Base Data Endpoints for Essential Scheduling
| Data Model/Path | Banner-Ethos Version | Colleague-Ethos Version | Access |
| academic-periods** | 16 | 16 | get |
| administrative-instructional-methods | 1 | 1 | get |
| administrative-periods | 1 | 1 | get |
| buildings | 6 | 6 | get |
| courses** | 16 | 16 | get |
| course-statuses | 1 | 1 | get |
| course-title-types | 1 | 1 | get |
| credit-categories | 6 | 6 | get |
| educational-institution-units | 7 | 7 | get |
| grade-modes | 6 | 6 | get |
| grade-schemes | 6 | 6 | get |
| instructional-delivery-methods | 11 | 11 | get |
| instructional-events** | 8 and 11 | 8 and 11 | get |
| instructional-methods | 6 | 6 | get |
| instructors | 9 | 9 | get |
| instructor-staff-types | 9 | 9 | get |
| person-name-types | 12 | 12 | get |
| persons | 12 | 12 | get |
| rooms | 10 | 10 | get |
| room-types | 10 | 6 | get |
| section-crosslists | 6 | 6 | get |
| section-description-types | 1 | 1 | get |
| section-registrations** | 16 | 16 | get |
| section-registration-statuses | 8 | 8 | get |
| sections** | 16 | 16 | get |
| section-statuses | 11 | 11 | get |
| section-title-types | 1 | 1 | get |
| sites | 6 | 6 | get |
| student-section-waitlists | 10 | 10 | get |
| subjects | 6 | 6 | get |
|
admin/available-resources** |
Note: Available-resources provides a listing of Ethos resources that are available to the integration as well as their versions. Ad Astra checks the versions supported by the instance to make sure they match the version Ad Astra will request from each endpoint. | ||
Publish for Essential Scheduling
| Path | Banner-Ethos Version | Colleague-Ethos Version | Access |
| sections** | 16 | 16 | post/put |
|
section-instructors |
10 | 10 | post/put & delete |
| instructional-events** | 8 and 11 | 8 and 11 | post/put & delete |
| Note: For Colleague Only - Room booking and Faculty booking are also required | |||
Extended Data Access Models for Student Centered Scheduling and Integrated Planning
| Name | Banner Version | Colleague Version |
| admission-decisions | 11 | 11 |
| student-academic-credentials | 1 | 1 |
| student-academic-programs | 17 | 17 |
| student-aptitude-assessments | 16 | 16 |
| student-course-transfers | 10 | 13 |
| students** | 16 | 16 |
| student-tag-assignments |
1 | N/A |
| student-transcript-grades | 1 | 1 |
Extended Data Endpoints for Student Centered Scheduling and Integrated Planning
| Data model/Path | Banner-Ethos Verson | Colleague-Ethos Version |
| academic-catalogs | 6 | 6 |
| academic-credentials | 6 | 6 |
| academic-disciplines | 15 | 15 |
| academic-levels | 6 | 6 |
| academic-programs | 15 | 15 |
| admission-application-status-types | 6 | 6 |
| admission-application-types | 6 | 6 |
| admission-decision-types | 11 | 11 |
| admission-populations | 6 | 6 |
| aptitude-assessments | 6 | 6 |
| course-categories | 11 | 11 |
| enrollment-statuses | 6 | 6 |
| ethnicities | 6 | 6 |
| gender-identities | 1 | 1 |
| grade-definitions | 6 | 6 |
| instructor-categories | 9 | 9 |
| races | 6 | 6 |
| residency-types | 7 | 7 |
| student-academic-credentials | 1 | 1 |
| student-academic-programs | 17 | 17 |
| student-aptitude-assessments | 16 | 16 |
| student-course-transfers | 10 | 13 |
| students | 16 | 16 |
| student-tag-assignments | 1 | N/A |
| student-tags | 7 | 7 |
| student-transcript-grades** | 1 | 1 |
| student-types | 7 | 7 |
Additional Data Requirements for Faculty Capacity (Beta)
Colleague - Ethos: The instructor endpoint already granted for Base data has some of the faculty data required for this report such as staff types, institutional units (division, department), and tenure. The additional data required for the Faculty Capacity report must be sent to Ad Astra via an Ethos extension.
- Colleague Ethos extensibility considerations (Ellucian Documentation)
- Faculty Contract data (This data is accessible in the Faculty Contract Colleague Non-Ethos Web API and link here is provided as an example of where this data is housed).
- Id
- Contract Description
- Contract Number
- Contract Type
- StartDate
- EndDate
- LoadPeriodId
- IntendedTotalLoad
- TotalValue
- FacultyContractPositions
Banner - Ethos (Coming Soon!)
Page History:
| Article Updates Made | Date |
|
8/19/24 |
| Moved credit-categories endpoint from Extended Data to Base Data | 10/3/24 |
| Added clarification to page that the only resources to add for GraphQL are those in the Data Access lists. | 10/24/24 |
| Added instructional-events version 11 support | 3/11/25 |
| Added Faculty Capacity (beta) requirements for Ethos Colleague | 3/24/25 |
Comments
This documentation does not specify whether to add these resources under "GraphQL Resources" or "Resource Subscriptions".
The resources need added under "GraphQL Resources".
Thank you for your prompt response, much appreciated!
Hi there, is the list for essential scheduling expanded? It used to be like 18 resources. Thanks.
Hello Foster, yes the Essential Scheduling list has been expanded. We do not anticipate any further changes. Let us know if you need further assistance. Thank you!
Hello, Do we need to add all the Base Data Endpoints for Essential Scheduling, the Extended Data Endpoints for Student-Centered Scheduling and Integrated Planning, and the Base Data Access Models for Essential Scheduling to the Ethos integration application under the GraphQL Resources tab?
Hello! The only resources to add for GraphQL are those in the Data Access lists. We just need permissions for the API resources. I've added a clarifying comment to the Data Access section. Thanks for reaching out.
Please sign in to leave a comment.