Service Directory > v32.1 > Academic_Foundation > Import_Student_Housing_Assignments
 

Operation: Import_Student_Housing_Assignments

The Web Service Background Process used to Import Student Housing Assignments. Can either specify an ID of an existing Student Housing Assignment to edit it, or create a new Student Housing Assignment if the ID currently doesn't exist.


@ - 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: Import_Student_Housing_Assignment_Request

The Import Student Housing Assignment Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  The Student Housing Assignment ID for the Import Student Housing Assignment Request Element   
Student_Housing_Assignment_Data  Student_Housing_Assignment_Data  [0..*]  The Student Housing Assignment Data Element for the Import Student Housing Assignment Request Element 
Validation Description
Location for Student Housing Assignment must contain usage type "Housing"   
 
Validation Description
Please enter a Student Housing Assignment Data Load ID that is not already in use   
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Student_Housing_Assignment_Data

part of: Import_Student_Housing_Assignment_Request
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
 

StudentObject

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

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
 

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
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
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top