Service Directory > v33.1 > Academic_Foundation > Submit_Student_Residency
 

Operation: Submit_Student_Residency

This web service operation will create or update effective-dated residency information for a Student. This task also allows Student Documents for residency determination to be created or edited.


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

Submit Student Residency Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Residency_Data  Student_Residency_Data  [1..1]  Student Residency Data element 
Validation Description
Can not enter Resident Detail if Residency Status is not Resident.   
Residency Status must be set to Resident, Nonresident, or Undetermined.   
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.   
The Residency Reason must be associated with the Residency Record's Institutional Academic Unit.   
The Residency Reason must be active.   
The Residency Reason must be associated with the Residency Status.   
Enter either an Effective Academic Period or a Snapshot Effective Date.   
The student must have an active Financial Aid Period Record for this academic period.   
Effective Academic Period can only be entered when determining residency for a Student that has Matriculated for a Program of Study within the Institutional Academic Unit.   
Select an Academic Period that's current or in the future.   
Select an Effective Date or Effective Academic Period for a matriculated student.   
Registration for this academic period is not open at this time because of Academic Period Date Controls.   
 
top
 

Response Element: Submit_Student_Residency_Response

Submit Student Residency Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Reference  StudentObject  [0..1]  Student Reference   
top
 

Student_Residency_Data

part of: Submit_Student_Residency_Request
Student Residency Data element
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Adds an Effective Academic Period to a residency record.   
Effective_Date  date  [0..1]  Effective Date   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [1..1]  Institutional Academic Unit Reference   
Student_and_Universal_ID_Data  Student_and_Universal_ID_Data  [1..1]  Reference to Student using Student or Universal ID 
Validation Description
You can only refer to one Student when entering a Universal ID and/or a Student ID.   
 
Student_Residency_Status_Reference  Student_Residency_StatusObject  [1..1]  Student Residency Status Reference   
Resident_Detail_Reference  Resident_DetailObject  [0..1]  Resident Detail Reference   
Residency_Reason_Reference  Residency_ReasonObject  [0..1]  Adds a Residency Reason to a residency record.   
Residency_Declaration_Date  date  [0..1]  Residency Declaration Date   
Student_Prospect_Stage_Reference  Student_Prospect_StageObject  [0..1]  Student Prospect Stage   
Student_Residency_Document_Data  Student_Residency_Document_Data  [0..*]  Student Residency Document Data element 
Validation Description
You cannot assign student documents to inactive student document types.   
The Student Proxy must be for this student.   
Only Student Document Types with a category of Residency Determination are allowed.   
 
Validation Description
Can not enter Resident Detail if Residency Status is not Resident.   
Residency Status must be set to Resident, Nonresident, or Undetermined.   
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.   
The Residency Reason must be associated with the Residency Record's Institutional Academic Unit.   
The Residency Reason must be active.   
The Residency Reason must be associated with the Residency Status.   
Enter either an Effective Academic Period or a Snapshot Effective Date.   
The student must have an active Financial Aid Period Record for this academic period.   
Effective Academic Period can only be entered when determining residency for a Student that has Matriculated for a Program of Study within the Institutional Academic Unit.   
Select an Academic Period that's current or in the future.   
Select an Effective Date or Effective Academic Period for a matriculated student.   
Registration for this academic period is not open at this time because of Academic Period Date Controls.   
top
 

Academic_PeriodObject

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

Academic_UnitObject

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

Student_and_Universal_ID_Data

part of: Student_Residency_Data
Reference to Student using Student or Universal ID
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  The Student who is being Referenced.   
Universal_ID_Reference  Universal_IdentifierObject  [0..1]  Universal ID of the Student who is being Referenced.   
Validation Description
You can only refer to one Student when entering a Universal ID and/or a Student ID.   
top
 

StudentObject

part of: Submit_Student_Residency_Response, Student_and_Universal_ID_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
 

Universal_IdentifierObject

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

Universal_IdentifierObjectID

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

Residency_ReasonObject

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

Residency_ReasonObjectID

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

part of: Student_Residency_Data
Student Residency 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   
Student_Proxy_Reference  Student_ProxyObject  [0..1]  The Student Proxy Reference for the student document.   
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.   
The Student Proxy must be for this student.   
Only Student Document Types with a category of Residency Determination are allowed.   
top
 

Student_Document_TypeObject

part of: Student_Residency_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_ProxyObject

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

Student_ProxyObjectID

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

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Universal_IdentifierReferenceEnumeration

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

Residency_ReasonReferenceEnumeration

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

Student_ProxyReferenceEnumeration

part of: Student_ProxyObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top