Required Ethos Endpoints

On this page, you will find a list of Ethos endpoints that Housing.Cloud requires access to. Please review the endpoints required for each data type.

 

Data Types

It is likely that these endpoints may vary depending on the individual needs of an Institution. Please check your institution's data contract for clarification. 

Profile

Endpoint	HTTP Method	Is Required	Notes
persons	GET	Yes
academic-periods	GET	Yes
student-academic-periods	GET	Yes
addresses	GET	No
students	GET	Yes

Occupancy (a.k.a. Housing Assignment)

Endpoint	HTTP Method	Is Required	Notes
persons	GET	Yes
academic-periods	GET	Yes
housing-requests	GET, POST	Yes*	Required only for Banner
housing-assignments	POST, PUT, GET	Yes
room-rates	GET	Yes
rooms	GET	Yes
buildings	GET	Yes

Meal Plan Assignment

Endpoint	HTTP Method	Is Required	Notes
persons	GET	Yes
academic-periods	GET	Yes
meal-plans	GET	Yes
meal-plan-requests	POSY	Yes*	Required only for Banner
meal-plan-assignments	POST, PUT, GET	Yes
meal-plan-rates	GET	Yes

Transactions

Endpoint	HTTP Method	Is Required	Notes
persons	GET	Yes
academic-periods	GET	Yes
accounting-codes	GET	Yes
student-charges	POST, GET	Yes