Service Directory > v31.2 > Academic_Foundation > Get_Student_Residencies
 

Operation: Get_Student_Residencies

This web service operation returns effective-dated Student residency information and the Student Documents that support the residency information. The Student, Institutional Academic Unit and Effective Date request criteria can be used to identify a specific subset of Students who have had their residency statuses determined. If the Effective Date request criteria is not used, only currently effective residency data will be returned. This operation does not support Request References. The Response Groups element can be used to include or exclude the Student Document Attachment data from the response.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Student_Residencies_Request

Get Student Residencies Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Residency_Request_References  [0..1]  Student Residency Request References element   
Request_Criteria [Choice]   Student_Residency_Request_Criteria  [0..1]  Student Residency Request Criteria element   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Student_Residency_Response_Group  [0..1]  Student Residency Response Group element   
top
 

Response Element: Get_Student_Residencies_Response

Get Student Residencies Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Residency_Request_References  [0..1]  Student Residency Request References element   
Request_Criteria  Student_Residency_Request_Criteria  [0..1]  Student Residency Request Criteria element   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Student_Residency_Response_Group  [0..1]  Student Residency Response Group element   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Student_Residency_Response_Data  [0..1]  Student Residency Response Data element   
top
 

Student_Residency_Request_References

part of: Get_Student_Residencies_Request, Get_Student_Residencies_Response
Student Residency Request References element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Student_Residency_Request_Criteria

part of: Get_Student_Residencies_Request, Get_Student_Residencies_Response
Student Residency Request Criteria element
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The effective date of the residency data   
Student_Reference  StudentObject  [0..*]  References to the Students to be returned   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [0..*]  References to the Institutional Academic Units for which Students had their residency determined   
top
 

StudentObject

part of: Student_Residency_Request_Criteria, Student_Residency, Student_Residency_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  StudentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

StudentObjectID

part of: StudentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Person_ID, Student_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Academic_UnitObject

part of: Student_Residency_Request_Criteria, Student_Residency_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Academic_UnitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_UnitObjectID

part of: Academic_UnitObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Unit_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Student_Residencies_Request, Get_Student_Residencies_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Student_Residency_Response_Group

part of: Get_Student_Residencies_Request, Get_Student_Residencies_Response
Student Residency Response Group element
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
Include_Student_Documents_in_Response  boolean  [0..1]  Include Student Document Attachments in Response   
top
 

Response_Results

part of: Get_Student_Residencies_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Student_Residency_Response_Data

part of: Get_Student_Residencies_Response
Student Residency Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Student_Residency  Student_Residency  [0..*]  Student Residency element   
top
 

Student_Residency

part of: Student_Residency_Response_Data
Student Residency element
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Reference   
Student_Residency_Data  Student_Residency_Data  [1..*]  Student Residency Data element 
Validation Description
Can not enter Resident Detail if Residency Status is not Resident.   
Resident Detail is required if Student Residency Status is Resident.   
Only Student Document Types with a category of Residency Determination are allowed.   
Residency Status must be set to Resident, Nonresident, or Undetermined.   
Effective Date is required when submitting residency information for a Student that has a Student Prospect Stage of Student.   
Snapshot Effective Date can only be entered when determining residency for a Student that has Matriculated for a Program of Study within the Institutional Academic Unit.   
Furthest Student Prospect Stage cannot be updated with this web service.   
 
top
 

Student_Residency_Data

part of: Student_Residency
Student Residency Data element
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [1..1]  Institutional Academic Unit Reference   
Student_Reference  StudentObject  [1..1]  Student Reference   
Student_Residency_Status_Reference  Student_Residency_StatusObject  [1..1]  Student Residency Status Reference   
Resident_Detail_Reference  Resident_DetailObject  [0..1]  Resident Detail Reference   
Residency_Declaration_Date  date  [0..1]  Residency Declaration Date   
Student_Prospect_Stage_Reference  Student_Prospect_StageObject  [0..1]  Student Prospect Stage   
Student_Document_Data  Student_Document_Data  [0..*]  Student Document Data element 
Validation Description
You cannot assign student documents to inactive student document types.   
 
Validation Description
Can not enter Resident Detail if Residency Status is not Resident.   
Resident Detail is required if Student Residency Status is Resident.   
Only Student Document Types with a category of Residency Determination are allowed.   
Residency Status must be set to Resident, Nonresident, or Undetermined.   
Effective Date is required when submitting residency information for a Student that has a Student Prospect Stage of Student.   
Snapshot Effective Date can only be entered when determining residency for a Student that has Matriculated for a Program of Study within the Institutional Academic Unit.   
Furthest Student Prospect Stage cannot be updated with this web service.   
top
 

Student_Residency_StatusObject

part of: Student_Residency_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Student_Residency_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Residency_StatusObjectID

part of: Student_Residency_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Student_Application_Residency_Status_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Resident_DetailObject

part of: Student_Residency_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Resident_DetailObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Resident_DetailObjectID

part of: Resident_DetailObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Resident_Details_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Student_Prospect_StageObject

part of: Student_Residency_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Student_Prospect_StageObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Prospect_StageObjectID

part of: Student_Prospect_StageObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Student_Prospect_Stage_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Student_Document_Data

part of: Student_Residency_Data
Student Document Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID of the Student Document   
Student_Document_Type_Reference  Student_Document_TypeObject  [1..1]  Student Document Type Reference   
Upload_Date  dateTime  [0..1]  Upload Date   
Date_Received  date  [0..1]  Date Received   
Official  boolean  [0..1]  Official   
Student_Document_Attachment_Data  Student_Document_Attachment_Data  [0..1]  Student Document Attachment Data element   
Validation Description
You cannot assign student documents to inactive student document types.   
top
 

Student_Document_TypeObject

part of: Student_Document_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Student_Document_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Document_TypeObjectID

part of: Student_Document_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Student_Supporting_Material_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Student_Document_Attachment_Data

part of: Student_Document_Data
Student Document Attachment Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID of the Student Document Attachment   
Attachment_WWS_Data  Attachment_WWS_Data  [1..1]  Attachment WWS Data element   
top
 

Attachment_WWS_Data

part of: Student_Document_Attachment_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

part of: Attachment_WWS_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Mime_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Mime_TypeObjectID

part of: Mime_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Content_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Student_Residency_StatusReferenceEnumeration

part of: Student_Residency_StatusObjectID
Base Type
string
top
 

Resident_DetailReferenceEnumeration

part of: Resident_DetailObjectID
Base Type
string
top
 

Student_Prospect_StageReferenceEnumeration

part of: Student_Prospect_StageObjectID
Base Type
string
top
 

Student_Document_TypeReferenceEnumeration

part of: Student_Document_TypeObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top