Service Directory > v31.2 > Admissions > Submit_Student_Application_Withdrawal
 

Operation: Submit_Student_Application_Withdrawal

Withdraws a Student Application and initiates the Withdraw Student Application Business Process.


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

Request Element for Withdraw Student Application
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Student_Application_Withdraw_Event_Data  Student_Application_Withdraw_Event_Data  [0..1]  Element Container for Student Application Withdraw Event Data 
Validation Description
Cannot withdraw application that is inactive or has a decision status of Publicly Available.   
Withdrawal date must be after the Application Date.   
The recruitment for this application has another active application and therefore Continue Recruiting must be set to True.   
The recruitment for this application has another active application and therefore the Anticipated Start cannot be changed.   
The recruitment for this application has another active application and therefore the Anticipated Start cannot be changed.   
Cannot set Anticipated Start Academic Period for recruitment with Dynamic Academic Period.   
Cannot set Anticipated Start Date for recruitment with Fixed Academic Period.   
Student Anticipated Start Date is Required.   
Anticipated Start Academic Period is Required.   
Anticipated Start cannot be changed if Continue Recruiting is not set to True.   
Select a unique combination of Academic Level, Academic Unit, and Anticipated Start for the prospect.   
A withdrawal for this application is already in progress.   
Anticipated Start Academic Period must be a current or future Academic Period.   
Anticipated Start Date must be today or later.   
The Anticipated Start Academic Period must be configured with the Academic Unit and Academic Level for the Recruitment.   
 
top
 

Response Element: Submit_Student_Application_Withdrawal_Response

Response Element for Submit Student Application Withdrawal
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Application_Reference  Student_ApplicationObject  [0..1]  Student Application that is being withdrawn   
top
 

Business_Process_Parameters

part of: Submit_Student_Application_Withdrawal_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

part of: Submit_Student_Application_Withdrawal_Request
Withdrawal information for Student Application Withdrawal
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Reference  Student_ApplicationObject  [1..1]  The Student Application to be withdrawn   
Withdrawal_Date  date  [1..1]  The withdrawal date for the application to be withdrawn   
Student_Application_Withdrawal_Reason_Reference  Student_Application_Withdrawal_ReasonObject  [1..*]  The reason for the application being withdrawn   
Student_Application_Withdrawal_Comments  string  [0..1]  Comments for the application withdrawal   
Continue_Recruiting  boolean  [0..1]  Boolean to determine whether or not to continue recruiting the prospect for the withdrawn application   
Student_Anticipated_Start_Date  date  [0..1]  Anticipated Start Date of a Dynamic Academic Period that the student will be continued to be recruited for   
Anticipated_Start_Academic_Period_Reference  Academic_PeriodObject  [0..1]  Anticipated Starting Fixed Academic Period that the student will be continued to be recruited for   
Validation Description
Cannot withdraw application that is inactive or has a decision status of Publicly Available.   
Withdrawal date must be after the Application Date.   
The recruitment for this application has another active application and therefore Continue Recruiting must be set to True.   
The recruitment for this application has another active application and therefore the Anticipated Start cannot be changed.   
The recruitment for this application has another active application and therefore the Anticipated Start cannot be changed.   
Cannot set Anticipated Start Academic Period for recruitment with Dynamic Academic Period.   
Cannot set Anticipated Start Date for recruitment with Fixed Academic Period.   
Student Anticipated Start Date is Required.   
Anticipated Start Academic Period is Required.   
Anticipated Start cannot be changed if Continue Recruiting is not set to True.   
Select a unique combination of Academic Level, Academic Unit, and Anticipated Start for the prospect.   
A withdrawal for this application is already in progress.   
Anticipated Start Academic Period must be a current or future Academic Period.   
Anticipated Start Date must be today or later.   
The Anticipated Start Academic Period must be configured with the Academic Unit and Academic Level for the Recruitment.   
top
 

Student_ApplicationObject

part of: Student_Application_Withdraw_Event_Data, Submit_Student_Application_Withdrawal_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_Withdrawal_ReasonObject

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

Student_Application_Withdrawal_ReasonObjectID

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

Academic_PeriodObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Student_ApplicationReferenceEnumeration

part of: Student_ApplicationObjectID
Base Type
string
top
 

Student_Application_Withdrawal_ReasonReferenceEnumeration

part of: Student_Application_Withdrawal_ReasonObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top