Housing.Cloud is capable of generating a Meal Plan Assignment CSV file with the intent of being consumed by CS Golds's Meal Plan service. The CSV transmission process will follow Housing.Cloud's standard SFTP process.

 

Configuration

  1. Institution will specify the transfer cadence of the file (e.g. every 30 minutes)
    1. The cadence can be any value supported by a Cron string, but it must be equal to or greater than every 10 minutes

File Format

Column Header Data Type Required Description
name string Yes Meal Plan name in Housing.Cloud
externalId string Yes Meal Plan externalCode in Housing.Cloud
dateStart date string Yes Meal Plan duration dateStartin Housing.Cloud
dateEnd date string Yes Meal Plan duration dateEndin Housing.Cloud
sisId string Yes The sisId of a user
schoolEmail string Yes The primary .edu email of a user
externalTermId string Yes The associated externalTermCode of the Cycle
dateCancellation date string Yes The date in which an assignment was cancelled
dateAssigned date string Yes The date in which an assignment was created
isFlexPoint boolean Yes Whether or not the assignment is a Housing.Cloud Flex Point Purchase
secondaryExternalId string No Data Mapping "includeSecondaryExternalId" required

 

Data Type Clarifications:

  • Date String will be an ISO date string using the format: yyyy-mm-ddTHH:MM:SS.MSZ
  • It is possible that externalId and externalTermId are empty strings as those are pass-through values that must be confirmed by a Housing Administrator
  • The field dateCancelled will be an empty string if the meal plan is active

Notes:

  • A Meal Plan Assignment will appear in the file as soon as a user has selected one
  • The file may contain multiple rows for a singular user for two primary reasons:
    • The file may contain assignments for multiple Cycles
    • If the user personally re-selected meal plans or an Administrator changed meal plans on their behalf (meal plan user re-selection can be disabled in Housing.Cloud through various means)