Ethos Ingress: Custom Profile Fields

Last updated: August 28, 2026

This document describes the expected setup for populating Profile Fields via Ethos.

 

General Enablement Notes:

  1. The Profile Field Name in Housing.Cloud must match exactly what is in this document
    1. If the Profile Field has options, those options must match exactly what is returned from Ethos
  2. Many of the Profile Fields have dependencies on prior API calls and those calls may fail and every API call takes a significant amount of time
    1. We execute request memoization and parallelization, but too much parallelization (~500 requests) is likely to bring down the Ethos servers due to the lack of connection pooling between Ethos and Banner/Colleague
  3. The data returned from Ethos is the data we utilize. There is no customized semantic mappings or calculations applied to the fields.

Supported Fields

Field Name Example Values Endpoint
gender male, female, unknown persons
preferred gender male, female, non-binary gender-identities
student level graduate, undergraduate academic-levels
student type continuing, first time, transfer student-types
student classification freshman, sophomore, junior, senior student-classifications
student program school of arts, satellite campus academic-programs
current major english, computer science, business academic-disciplines
cumulative gpa 3.87 student-grade-point-averages
cumulative credits 42 student-grade-point-averages
external role student, employee, alumni persons
race back or african american, asian, white races

 

Field Configurations

Gender

  • Endpoint: /persons
    • Version: application/vnd.hedtech.integration.v12+json
Field Name Prerequisites Banner Field Colleague Field
gender N/A SPBPERS_SEX Person.gender

 

Preferred Gender

  • Endpoint: /gender-identities
    • Version: application/vnd.hedtech.integration.v1+json
Field Name Prerequisites Banner Field Colleague Field
preferred gender genderIdentityId GTVGNDR_GNDR_DESC VAL.EXTERNAL.REPRESENTATION

 

Student Level

  • Endpoint: /academic-levels
    • Version: application/vnd.hedtech.integration.v6+json
Field Name Prerequisites Banner Field Colleague Field
student level extLevelId STVLEVL_DESC ACAD.LEVELS.ACLV.DESC

 

Student Type

  • Endpoint: /academic-types
    • Version: application/vnd.hedtech.integration.v7+json
Field Name Prerequisites Banner Field Colleague Field
student type extStudentTypeId STVSTYP_DESC STUDENT.TYPES.STT.DESC

 

Student Classification

  • Endpoint: /student-classifications
    • Version: application/vnd.hedtech.integration.v7+json
Field Name Prerequisites Banner Field Colleague Field
student classification extClassificationId STVCLAS_DESC CLASSES.CLS.DESC

 

Student Program

  • Endpoint: /academic-programs
    • Version: application/vnd.hedtech.integration.v15+json
Field Name Prerequisites Banner Field Colleague Field
student program programId

SMRPLE_PROGRAM_DESCor

GORGUID_DOMAIN_KEY

 ACPG.TITLE

 

Current Major

  • Endpoint: /academic-disciplines
    • Version: application/vnd.hedtech.integration.v15+json
Field Name Prerequisites Banner Field Colleague Field
current major disciplineIds STVMAJR_DESC OMAJ.DESCor OMIN.DESCor OSPC.DESC

 

Cumulative Grade Point Average

  • Endpoint: /student-grade-point-averages
    • Version: application/vnd.hedtech.integration.v1+json
Field Name Prerequisites Banner Field Colleague Field
cumulative gpa student level SHRLGPA_GPA PST.STUDENT.ACAD.CRED

 

Cumulative Earned Credits

  • Endpoint: /student-grade-point-averages
    • Version: application/vnd.hedtech.integration.v1+json
Field Name Prerequisites Banner Field Colleague Field
cumulative credits student level SHRLGPA_HOURS_EARNED STC.CUM.CONTRIB.GPA.CRED

 

External Role

  • Endpoint: /persons
    • Version: application/vnd.hedtech.integration.v12+json
Field Name Prerequisites Banner Field Colleague Field
external role N/A derived derived

 

Race

  • Endpoint: /races
    • Version: application/vnd.hedtech.integration.v6+json
Field Name Prerequisites Banner Field Colleague Field
race raceIds GORRACE_DESC VAL.EXTERNAL.REPRESENTATION

 

Field Prerequisites

Students

  • Endpoint: /students
    • Version: application/vnd.hedtech.integration.v16+json
HC FieldName Path Banner Field Colleague Field
extClassificationId levelClassification.latestClassification.id derived STA.CLASS
extLevelId levelClassification.level.id SORLCUR_LEVL_CODE STU.ACAD.LEVELS
extStudentTypeId types[].type.id (latest active type) SGBSTDN_STYP_CODE STU.TYPES

 

Persons

  • Endpoint: /persons
    • Version: application/vnd.hedtech.integration.v12+json
HC FieldName Path Banner Field Colleague Field
genderIdentityId genderIdentity.id SPBPERS_GNDR_CODE PERSON.genderIdentity.id
raceIds races[].race.id GORPRAC_RACE_CDE PERSON.races.race.id

 

Student Academic Programs

  • Endpoint: /student-academic-programs
    • Version: application/vnd.hedtech.integration.v17+json
HC FieldName Path Banner Field Colleague Field
programId program.id GORGUID_GUIDorSORLCUR_PROGRAM STPR.ACAD.PROGRAM
disciplineIds disciplines[].discipline.id SORLFOS_MAJR_CODE ACPG.MAJORS

 

Notes: