Service Directory > v25.1 > Admissions > Put_Student_Application_Residency
 

Operation: Put_Student_Application_Residency

Uses a Put request to edit the Residency data for an existing Student Application.


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

The Put request for a Student Application Residency.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Application_Residency_Data  Student_Application_Residency_Data  [1..1]  The Put request for a Student Application Residency. 
Validation Description
Resident Detail is required if Student Application Residency Status is Resident.  Resident Detail is required if Student Application Residency Status is Resident. 
Can not enter Resident Detail if Residency Status is not Resident.   
 
top
 

Response Element: Put_Student_Application_Residency_Response

The Put request for a Student Application Residency.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Application_Reference  Student_ApplicationObject  [0..1]  Contains the reference for a Student Application.   
top
 

Student_Application_Residency_Data

part of: Put_Student_Application_Residency_Request
Contains a Student Application reference and the Residency data for that application.
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Reference  Student_ApplicationObject  [1..1]  Contains the reference for a Student Application.   
Student_Application_Residency_Status_Reference  Student_Application_Residency_StatusObject  [1..1]  Contains the reference to a Residency Status.   
Resident_Detail_Reference  Resident_DetailObject  [0..1]  Contains the reference to a Resident Detail.   
Validation Description
Resident Detail is required if Student Application Residency Status is Resident.  Resident Detail is required if Student Application Residency Status is Resident. 
Can not enter Resident Detail if Residency Status is not Resident.   
top
 

Student_ApplicationObject

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

Student_ApplicationObjectID

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

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

Student_Application_Residency_StatusObjectID

part of: Student_Application_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_Application_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_ApplicationReferenceEnumeration

part of: Student_ApplicationObjectID
Base Type
string
top
 

Student_Application_Residency_StatusReferenceEnumeration

part of: Student_Application_Residency_StatusObjectID
Base Type
string
top
 

Resident_DetailReferenceEnumeration

part of: Resident_DetailObjectID
Base Type
string
top