Ethos Data Access Models and Endpoints

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, we have not found the documentation for Banner yet)

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.

  1. Configure the Data Access Models and Endpoints as specified in the tables below for the products you are integrating
  2. Access the tool here: https://app.adastra.live/readiness/
  3. Select which product you are integrating (Essential Scheduling or Student-Centered Scheduling)
  4. Select your SIS (Banner or Colleague)
  5. 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.

Base Data Access Models for Essential Scheduling

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, you'll need to contact Ellucian)

Name Banner  Version Colleague Version
persons 12 12
sections 16 16
section-registrations 16 16
section-instructors
10 10
instructional-events 8 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
academic-periods 16 16
administrative-instructional-methods 1 1
administrative-periods 1 1
buildings 6 6
courses 16 16
course-statuses 1 1
course-title-types 1 1
educational-institution-units 7 7
grade-modes 6 6
grade-schemes 6 6
instructional-delivery-methods 11 11
instructional-events 8 8
instructional-methods 6 6
instructors 9 9
instructor-staff-types 9 9
person-name-types 12 12
persons 12 12
rooms 10 10
room-types 10 6
section-crosslists 6 6
section-description-types 1 1
section-registrations 16 16
section-registration-statuses 8 8
sections 16 16
section-statuses 11 11
section-title-types 1 1
sites 6 6
student-section-waitlists 10 10
subjects 6 6
 
admin/available-resources
Note: The path is different on this one and there are no versions

 

Publish for Essential Scheduling

Data Model/Path Banner-Ethos Version Colleague-Ethos Version Access
sections 16 16 post/put
section-instructors
10 10 post/put & delete
instructional-events 8 8 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-applications 16 16
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
credit-categories 6 6
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

 


Was this article helpful?
0 out of 0 found this helpful

Comments

3 comments
  • This documentation does not specify whether to add these resources under "GraphQL Resources" or "Resource Subscriptions".

    0
  • The resources need added under "GraphQL Resources".

    1
  • Thank you for your prompt response, much appreciated!

    0

Please sign in to leave a comment.