Retrieves a collection of residence information for the specified student ID.

Workday Resource Information

Retrieves a collection of residence information for the specified student ID. You can filter residence information by their institutionalAcademicUnit.

Secured by: Manage: Student Residency, Self-Service: Student External Site User Access

Scope: Academic Foundation, Student Core

Columns

Name	Type	Description
Id [KEY]	String	Id of the instance
Students_Id [KEY]	String	The Workday ID of the Students that owns this.
Declaration	Datetime	The date on which this student declared residency.
Descriptor	String	The display name of the instance
Detail_Descriptor	String	The display name of the instance
Detail_Href	String	A link to the instance
Detail_Id	String	wid / id / reference id
Effective	Datetime	The date on which this residency status became (or will become) effective.
EffectiveAcademicPeriod_Descriptor	String	The display name of the instance
EffectiveAcademicPeriod_Href	String	A link to the instance
EffectiveAcademicPeriod_Id	String	wid / id / reference id
Reason_Descriptor	String	The display name of the instance
Reason_Href	String	A link to the instance
Reason_Id	String	wid / id / reference id
Status_Descriptor	String	The display name of the instance
Status_Href	String	A link to the instance
Status_Id	String	wid / id / reference id
InstitutionalAcademicUnit_Prompt	String	The Institutions.
AcademicLevel_Prompt	String
AcademicUnit_Prompt	String	Derived Academic Units.
ActiveOnly_Prompt	Bool	Only return active students.
ProgramOfStudy_Prompt	String	For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record.
Search_Prompt	String	A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker.