Explanation

In some cases, delivered Ethos endpoints do not include all fields or entities required for integration.

If a required field or entity is included in the partner’s scope of work (SOW), Element451 can support reading or writing that data. However, the field must first be made available through an Ethos extension.

There are two types of extensions:

• Delivered Entity Extension: Used when the field exists on a standard Colleague screen or entity
• Custom Entity Extension: Used when the data exists on a custom screen or entity

Delivered Entity Extension

Use this approach when extending an existing Ethos endpoint.

Selecting the Correct Endpoint

Choose the endpoint based on where the data exists in Colleague:

• Person-level data → /api/persons
• Application data → /api/admission-applications
• School-specific data → /api/person-external-education
• Other endpoints as applicable

Setup Steps

1. In Colleague, navigate to EAEE
2. At the lookup prompt, enter the resource name (e.g., persons, admission-applications)
   • If the resource does not exist, select Add
3. Navigate to EAEV and configure:
   • Description: Extend Element451 integration
   • Version Number: Leave blank (or leave at default value, do not increment)
   • Version Status: R (Released)