The Ethos integration requires a defined set of API permissions to allow Element451 to exchange data with the SIS.
Element451 uses multiple Ethos resources (API endpoints) to:
The specific endpoints required may vary by partner depending on the scope of the integration.
It is important to confirm that all required permissions are correctly configured before beginning the integration build.
Partners can validate access using the Ethos API Key Checker. This tool verifies that the configured API key has access to the required endpoints.
Note: Depending on the volume of data in the SIS, the check may take several minutes to complete
| Name | Access | Description | Resource Type |
|---|---|---|---|
| admission-populations | Read | Provides categories of admission populations for prospective students, which is used as “Student Type” in Element451. | Admission |
| admission-applications | Read + Write | Provides details about student applications for admission. | Admission |
| admission-decisions | Read + Write | Provides details about decisions made on applications for admission | Admission |
| academic-periods | Read | Provides details about the time periods used by institutions, which is used as “Terms” in Element451. | Academic |
| academic-programs | Read | Provides details about the offerings, majors, minors, etc, of an institution. Only sometimes needed | Academic |
| academic-credentials | Read | Relates to the completion of a specified course of study, which is used as “Degrees” in Element451. | Academic |
| academic-disciplines | Read | This entity is used to define academic programs, which is used as “Majors” in Element451 | Academic |
| person-matching-requests | Read + Write | Information about new person requests that are processed through duplicate prevention matching rules. | Person |
| persons | Read + Write | Information related to an individual person record. | Person |
| person-emergency-contacts | Read + Write | Information about people that should be contacted in the event of an emergency situation related to the subject person. | Person |
| students | Read | Information about a person who has, or is eligible to, register/enroll at the institution as a student. | Person |
| addresses | Read + Write | Information on the place where a person is located or may be reached. | Person |
| person-external-education | Read + Write | Information about the external institutions associated with a person. | Person |
| person-visas | Read + Write | Information about visas issued to a person. | Person |
| personal-relationships | Read + Write | Information related to the relationships between two people. | Person |
| person-holds | Read | Information around the holds related to the person record. | Academic |
| person-hold-types | Read | Information around the hold types defined by the institution. | Academic |
| student-academic-periods | Read | Information about a student for a specified academic period. | Academic |
| student-academic-programs | Read | Information about a student for a specified academic program. | Academic |
| student-academic-credentials | Read | Information about the academic credentials the student has been awarded. | Academic |
| student-grade-point-averages | Read | Information about the student’s GPAs. Used by the Enrolled Programs package. | Academic |
| educational-institutions | Read | Provides information about institutions that provide instructional or education related services. | Lookup |
| educational-goals | Read | Provides a list of user defined educational goals. | Lookup |
| sites | Read | Provides information about the physical locations that belong to a given institution, which is used as “Campuses” in Element451. | Lookup |
| ethnicities | Read | Provides information about ethnicity groupings as defined by the institution. | Lookup |
| citizenship-statuses | Read | Provides information about the status of being a citizen of a country. | Lookup |
| races | Read | Provides information about race groupings as defined by the institution. | Lookup |
| countries | Read | Provides a valid list of countries. Only sometimes used. | Lookup |
| alternative-credential-types | Read | Provides a valid list of alternative credential types. | Lookup |
| person-name-types | Read | Provides a way to distinguish between multiple names for the same person. | Lookup |
| address-types | Read | Provides a list of valid types of a physical address. | Lookup |
| email-types | Read | Provides a list of valid email types. | Lookup |
| phone-types | Read | Provides a list of valid phone types. | Lookup |
| student-types | Read | Provides a list of valid student types. | Lookup |
| student-statuses | Read | Provides a list of valid student statuses. | Lookup |
| relationship-types | Read | Provides a list of valid relationship types. | Lookup |
| visa-types | Read | Provides information about the type of an endorsement (visa) on a passport. | Lookup |
| admission-application-status-types | Read | Provides a list of valid admission application status types. | Lookup |
| admission-application-types | Read | Provides a list of valid types of admission applications. | Lookup |
| admission-decision-types | Read | Provides a list of valid admission decision types. | Lookup |
| admission-populations | Read | Provides the categories of admission populations. | Lookup |
| admission-residency-types | Read | Provides a list of admission applicants types of residency. | Lookup |
| aptitude-assessments | Read | Provide a list of test score codes. | Lookup |
| student-aptitude-assessments | Write | Information about a students tests. | Person |
| consume | Read | Provides records when changes happen. | Data Export |