StudentsResidencies
Retrieves a collection of residence information for the specified student ID.
Workday Resource Information
Retrieves a residence information for the student with the specified ID.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 | Supported for: SELECT. The date on which this student declared residency. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Detail_Descriptor | String | Supported for: SELECT. A description of the instance |
Detail_Href | String | Supported for: SELECT. A link to the instance |
Detail_Id | String | Supported for: SELECT. wid / id / reference id |
Effective | Datetime | Supported for: SELECT. The date on which this residency status became (or will become) effective. |
EffectiveAcademicPeriod_Descriptor | String | Supported for: SELECT. A description of the instance |
EffectiveAcademicPeriod_Href | String | Supported for: SELECT. A link to the instance |
EffectiveAcademicPeriod_Id | String | Supported for: SELECT. wid / id / reference id |
Reason_Descriptor | String | Supported for: SELECT. A description of the instance |
Reason_Href | String | Supported for: SELECT. A link to the instance |
Reason_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
InstitutionalAcademicUnit_Prompt | String | Accepts multiple inputs. The Institutions. |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available. |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Bool | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. 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 | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |