Service Directory > v32.1 > Student_Records > Import_Student_Withdrawals
 

Operation: Import_Student_Withdrawals

This web service imports Student Institutional Withdrawal Events. It executes the Business Process responsible for updating the Academic Record being withdrawn.


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

Import Student Withdrawal Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  ID   
Import_Student_Withdrawal_Data  Import_Student_Withdrawals_Data  [0..*]  Import Student Withdrawal Data 
Validation Description
An Institutional Withdrawal is already in effect for the Withdrawal Date.   
Please provide an academic record that is active as of the withdrawal date.   
You can't change the status of this academic record until the business process in progress is complete.   
The student has already received financial aid awards/tuition waivers for this academic period. To use this Withdrawal Date, cancel the disbursed awards/tuition waivers before requesting withdrawal.   
The program of study status reason isn't eligible for the selected criteria.   
A future dated program of study action already exists. You can’t add or change a program of study until that action is either effective or canceled.   
For students with only 1 academic record, specify a Student Reference. For students with multiple academic records, specify an Academic Record Reference.   
Student has more than one Academic Record. Please submit Academic Record Reference.   
 
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
 

Import_Student_Withdrawals_Data

part of: Import_Student_Withdrawals_Request
Import Student Withdrawal Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Reference ID   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Academic Record   
Withdrawal_Date  date  [1..1]  Student Withdrawal Date   
Withdrawal_Reason_Reference  Student_Program_of_Study_Record_Status_Reason__All_Object  [0..1]  Withdrawal Reason   
Validation Description
An Institutional Withdrawal is already in effect for the Withdrawal Date.   
Please provide an academic record that is active as of the withdrawal date.   
You can't change the status of this academic record until the business process in progress is complete.   
The student has already received financial aid awards/tuition waivers for this academic period. To use this Withdrawal Date, cancel the disbursed awards/tuition waivers before requesting withdrawal.   
The program of study status reason isn't eligible for the selected criteria.   
A future dated program of study action already exists. You can’t add or change a program of study until that action is either effective or canceled.   
For students with only 1 academic record, specify a Student Reference. For students with multiple academic records, specify an Academic Record Reference.   
Student has more than one Academic Record. Please submit Academic Record Reference.   
top
 

StudentObject

part of: Import_Student_Withdrawals_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_RecordObject

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

Academic_RecordObjectID

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

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

Student_Program_of_Study_Record_Status_Reason__All_ObjectID

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

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
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Student_Program_of_Study_Record_Status_Reason__All_ReferenceEnumeration

part of: Student_Program_of_Study_Record_Status_Reason__All_ObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top