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 your custom URL.

Monitor, Align, Schedule Building, and Events require access to the Base Data below.
Predict and Planning require access to the Extended Data below.

Postman Collections for Data Validation

Use Postman to ensure your Ellucian data is in shape for integration. 

  1. Download the Postman collections
  2. Update Authorization with the API key
  3. Send Authorization request
  4. Send other requests

Base Data Access Models

See Ellucian documentation for Ethos Data Access Configuration.
Ellucian's tool for viewing Data Access: https://dataaccess-admin.elluciancloud.com

Name Banner Version Colleague Version
persons 12 12
sections 16 16
sectionRegistrations 16 16
sectionInstructors
10 10
instructionalEvents 8 11
courses 16 16
rooms 10 15

 

Extended Data Access Models

Name Banner Version Colleague Version
admission-applications 16 16
admission-decisions 11 11
studentAcademicCredentials 1 1
studentAcademicPrograms 17 17
studentAptitudeAssessments 16 16
studentCourseTransfers 10 13
students 16 16
studentTagAssignments
1 N/A
studentTranscriptGrades 1 1

 

Base Data Endpoints

Data Model/Path Banner-Ethos Version Colleague-Ethos Version
academic-periods 16 16
administrative-instructional-methods 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

 

Extended Data Endpoints

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

 

Writeback (post/put access to these)

Data Model/Path Banner-Ethos Verson Colleague-Ethos Version
instructional-events 8 8
sections 16 16
section-instructors
10 10

 


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

Comments

0 comments

Please sign in to leave a comment.