Ethos Permissions / API Endpoints
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:
- Send data to the SIS
- Retrieve data from the SIS
- Sync data sources and supporting values
The specific endpoints required may vary by partner depending on the scope of the integration.
Permission Requirements#
- Each endpoint must have the appropriate read and/or write access enabled
- Permissions are typically configured based on Element451’s standard integration best practices
- Some implementations may require additional endpoints based on custom configurations
It is important to confirm that all required permissions are correctly configured before beginning the integration build.
Verifying Permissions#
Partners can validate access using the Ethos API Key Checker (opens in a new tab). 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
Ethos Resources
48 rows
| 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 |
| academic-periods | Read | Provides details about the time periods used by institutions, which is used as “Terms” in Element451. | Academic |
| admission-decisions | Read + Write | Provides details about decisions made on applications for admission | Admission |
| 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 |
| persons | Read + Write | Information related to an individual person record. | Person |
| person-matching-requests | Read + Write | Information about new person requests that are processed through duplicate prevention matching rules. | 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 |
| addresses | Read + Write | Information on the place where a person is located or may be reached. | Person |
| students | Read | Information about a person who has, or is eligible to, register/enroll at the institution as a student. | 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 |
| educational-institutions | Read | Provides information about institutions that provide instructional or education related services. | Lookup |
| 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-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 |
| citizenship-statuses | Read | Provides information about the status of being a citizen of a country. | Lookup |
| ethnicities | Read | Provides information about ethnicity groupings as defined by the institution. | Lookup |
| races | Read | Provides information about race groupings as defined by the institution. | Lookup |
| alternative-credential-types | Read | Provides a valid list of alternative credential types. | Lookup |
| countries | Read | Provides a valid list of countries. Only sometimes used. | 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 |
| 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 |
| visa-types | Read | Provides information about the type of an endorsement (visa) on a passport. | 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 |
| admission-decision-types | Read | Provides a list of valid admission decision types. | 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 |
| languages | Read | Provide a list of valid languages. | Lookup |
| transcript-types | Read | Provide a list of valid transcript types. | Lookup |
| transcript-statuses | Read | Provides a list of valid transcript statuses. | Lookup |
Was this page helpful?