Service Directory > v31.2 > Academic_Foundation > Get_Student_Housing_Assignments
 

Operation: Get_Student_Housing_Assignments

This Web Service Task is for: 1. Getting particular Student Housing Assignments 2. Getting all Student Housing Assignments 3. Getting all Student Housing Assignments for a Student


@ - 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_Housing_Assignments_Request

The Get Student Housing Assignments Request Element for the Get Student Housing Assignments Web Service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Housing_Assignment_Request_References  [0..1]  The Student Housing Assignment Request References Element for the Get Student Housing Assignments Web Service   
Request_Criteria [Choice]   Student_Housing_Assignment_Request_Criteria  [0..1]  The Student Housing Assignment Request Criteria Element for the Get Student Housing Assignments Web Service   
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. 
 
top
 

Response Element: Get_Student_Housing_Assignments_Response

The Get Student Housing Assignments Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Housing_Assignment_Request_References  [0..1]  The Student Housing Assignment Request References for the Get Student Housing Assignments Web Service   
Request_Criteria  Student_Housing_Assignment_Request_Criteria  [0..1]  The Student Housing Assignment Request Criteria for the Get Student Housing Assignments Web Service   
Response_Filter  Response_Filter  [0..1]  The Response Filter for the Get Student Housing Assignments Web Service 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The Response Results for the Get Student Housing Assignments Web Service   
Response_Data  Student_Housing_Assignment_Response_Data  [0..1]  The Student Housing Assignment Response Data for the Get Student Housing Assignments Web Service   
top
 

Student_Housing_Assignment_Request_References

part of: Get_Student_Housing_Assignments_Request, Get_Student_Housing_Assignments_Response
The Student Housing Assignment Request References Element for the Get Student Housing Assignments Web Service
 
Parameter name Type/Value Cardinality Description Validations
Student_Housing_Assignment_Reference  Student_Housing_AssignmentObject  [1..*]  The Student Housing Assignment Request References for the Get Student Housing Assignments Web Service   
top
 

Student_Housing_AssignmentObject

part of: Student_Housing_Assignment, Student_Housing_Assignment_Request_References
 
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_Housing_AssignmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Housing_AssignmentObjectID

part of: Student_Housing_AssignmentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Student_Housing_Assignment_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_Housing_Assignment_Request_Criteria

part of: Get_Student_Housing_Assignments_Request, Get_Student_Housing_Assignments_Response
The Student Housing Assignment Request Criteria Element for the Get Student Housing Assignments Web Service
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  The Student Reference for the Student Housing Assignment Request Criteria Element   
top
 

StudentObject

part of: Student_Housing_Assignment_Request_Criteria, Student_Housing_Assignment_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
 

Response_Filter

part of: Get_Student_Housing_Assignments_Request, Get_Student_Housing_Assignments_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
 

Response_Results

part of: Get_Student_Housing_Assignments_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_Housing_Assignment_Response_Data

part of: Get_Student_Housing_Assignments_Response
The Get Student Housing Assignments Response Element
 
Parameter name Type/Value Cardinality Description Validations
Student_Housing_Assignment  Student_Housing_Assignment  [0..*]  The Response Data Element for Student Housing Assignments   
top
 

Student_Housing_Assignment

part of: Student_Housing_Assignment_Response_Data
The Response Data Element for Student Housing Assignments
 
Parameter name Type/Value Cardinality Description Validations
Student_Housing_Assignment_Reference  Student_Housing_AssignmentObject  [0..1]  The Student Housing Assignment Reference   
Student_Housing_Assignment_Data  Student_Housing_Assignment_Data  [0..*]  The Element Holding all data relevant to Student Housing Assignments 
Validation Description
Location for Student Housing Assignment must contain usage type "Housing"   
 
top
 

Student_Housing_Assignment_Data

part of: Student_Housing_Assignment
The Element Holding All Information Relevant to Student Housing Assignments for the Web Service
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of a Student Housing Assignment   
Student_Reference  StudentObject  [1..1]  The Student Reference related to a Student Housing Assignment Reference   
Location_Reference  LocationObject  [1..1]  The Location related to a Student Housing Assignment Reference   
Student_Housing_Assignment_Room_Number  string  [0..1]  The Student Housing Assignment Room Number for a Student Housing Assignment Reference   
Student_Housing_Assignment_Room_Type  string  [0..1]  The Student Housing Assignment Room Type for a Student Housing Assignment Reference   
Student_Housing_Assignment_Status_Reference  Student_Housing_Assignment_StatusObject  [1..1]  The Student Housing Assignment Status for Student Housing Assignment   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  The Academic Period Associated with a Student Housing Assignment Reference   
Student_Housing_Assignment_Check_In_Date  dateTime  [1..1]  The Student Housing Assignment Check in Date associated with a Student Housing Assignment Reference   
Student_Housing_Assignment_Check_Out_Date  dateTime  [0..1]  The Student Housing Assignment Check Out Date associated with a Student Housing Assignment Reference   
Validation Description
Location for Student Housing Assignment must contain usage type "Housing"   
top
 

LocationObject

part of: Student_Housing_Assignment_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  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_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_Housing_Assignment_StatusObject

part of: Student_Housing_Assignment_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_Housing_Assignment_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Housing_Assignment_StatusObjectID

part of: Student_Housing_Assignment_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Student_Housing_Assignment_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
 

Academic_PeriodObject

part of: Student_Housing_Assignment_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_PeriodObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_PeriodObjectID

part of: Academic_PeriodObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Period_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_Housing_AssignmentReferenceEnumeration

part of: Student_Housing_AssignmentObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Student_Housing_Assignment_StatusReferenceEnumeration

part of: Student_Housing_Assignment_StatusObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top