Ethos Egress: Meal Plan Assignments

Last updated: August 28, 2026

This document describes how Housing.Cloud can push Meal Plan Assignments to Ethos. It is expected that the Institution executed the proper due diligence to determine that the Ellucian Ethos API Models can satisfy their Institution specific Business requirements. 

 

Banner Customers, please see additional information below the Meal Plan Assignment content.

 

API Details:

  • Endpoint: /meal-plan-assignments
    • Version: application/vnd.hedtech.integration.v16+json
  • Required HTTP Methods: POST, PUT, and GET

 

Meal Plan Assignments Data Model:

Field Name/Path Required Description
id Yes A null Ethos GUID value for POST and a valid GUID for PUT
person.id Yes A Profile's Ethos GUID
academicPeriod.id Yes Derived from the associated Cycle
mealPlan.id Yes A Meal Plan's Ethos GUID
status Yes Enum: assigned, cancelled
statusDate Yes The date in which the Egress API Request is executed
startOn Yes The start date of the Meal Plan Assignment in Housing.Cloud
endOn Yes The end date of the Meal Plan Assignment in Housing.Cloud
numberOfPeriods Yes This value will always be set to 1
assignedRates No Derived from the associated Meal Plan*

 

Meal Plan Assigned Rates Derivation Logic:

The Meal Plan Rate GUID is derived by the following steps:

  1. For the Meal Plan Assignment in question, the Meal Plan in Housing.Cloud (and thus the Meal Plan Ethos GUID)
  2. Housing.Cloud then polls the meal-plan-rates Ethos API endpoint (No query arguments are supported for the meal-plan-rates endpoint for the code value)
    1. For each response batch, Housing.Cloud attempts to match all of the following:
      1. The Meal Plan Ethos GUID in Housing.Cloud to the Meal Plan Rates mealPlan.id value
      2. Subsequent logic is dependent on the SIS:
        1. Banner: The Cycle's External Id in Housing.Cloud to the Meal Plan Rate Academic Period Id
        2. Colleague: The Meal Plan Rate with the latest active startOn date that is less than or equal to the Meal Plan Assignment Start Date
      3. Once those two criteria are met, the Meal Plan Rate GUID is parsed out

 

Configurations:

These values can be set in the Integration Configuration Data Mappings object.

  • mealPlanRatesRequired: If TRUE, the assignedRates attributes will be included in the POST payload
    • Note: This is required for institutions that utilize the Billing features within Colleague/Banner

 

Banner Customers

During the Meal Plan Assignment creation process, Banner requires an additional API call made to the Meal Plan Requests endpoint.

 

API Details:

  • Endpoint: /meal-plan-requests
    • Version: application/vnd.hedtech.integration.v10+json

  • Required HTTP Methods: POSTand GET

     

Housing Requests Data Model:

This additional API request is only required for Banner 

Field Name/Path Required Description
id Yes A null Ethos GUID value for POST
person.id Yes A Profile's Ethos GUID
academicPeriods.id Yes Derived from the associated Cycle
mealPlan.id Yes A Meal Plan's Ethos GUID
status Yes This value will always be: approved
startOn Yes The start date of the Occupancy in Housing.Cloud