Service Directory > v32.1 > Admissions > Submit_Change_Application_Anticipated_Start
 

Operation: Submit_Change_Application_Anticipated_Start

Creates a new Change Application Anticipated Start Event with the information supplied in the request.


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

Request for a Change Application Anticipated Start
 
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.   
Change_Application_Anticipated_Start_Data  Change_Application_Anticipated_Start_Data  [1..1]  Data for a Change Application Anticipated Start 
Validation Description
You must enter a New Academic Period Reference if the application period classification type is Fixed.   
You can't edit the secondary record of a match and merge pair after it has been merged.   
You can’t create applications for this academic unit, level, and start date, unless a matching cohort exists.   
You must enter a New Start Date if the application period classification type is Dynamic.   
Select an application that doesn't already have a rendered decision associated with it.   
You can't use academic periods for student applications with an academic period classification of Dynamic.   
Enter a new academic period that has the same calendar year as the current academic period on the application.   
You can't use dynamic dates for student applications with an academic period classification of Fixed.   
This request cannot be processed due to a pending Change of Anticipated Start.   
Student Application must be active.   
An application already exists for this combination of Academic Unit, Academic Level & Program of Study.   
An application already exists for this combination of Academic Unit, Academic Level & Program of Study.   
There is already an Active Admissions Application for this Student with this Program of Study/Anticipated Start/External Application Identifier combination   
 
top
 

Response Element: Submit_Change_Application_Anticipated_Start_Response

Response for the Change Application Anticipated Start
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Application_Reference  Student_ApplicationObject  [0..1]  Student Application for a Change Application Anticipated Start Event   
top
 

Business_Process_Parameters

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

Change_Application_Anticipated_Start_Data

part of: Submit_Change_Application_Anticipated_Start_Request
Data for a Change Application Anticipated Start
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Reference  Student_ApplicationObject  [1..1]  Student Application for a Change Application Anticipated Start Event   
New_Anticipated_Start_Date  date  [0..1]  Preferred Anticipated Start Date on an Application   
New_Academic_Period_Reference  Academic_PeriodObject  [0..1]  Preferred Starting Academic Period on an Application   
Date_of_Change  date  [0..1]  The date of the Change Application Anticipated Start Event   
Validation Description
You must enter a New Academic Period Reference if the application period classification type is Fixed.   
You can't edit the secondary record of a match and merge pair after it has been merged.   
You can’t create applications for this academic unit, level, and start date, unless a matching cohort exists.   
You must enter a New Start Date if the application period classification type is Dynamic.   
Select an application that doesn't already have a rendered decision associated with it.   
You can't use academic periods for student applications with an academic period classification of Dynamic.   
Enter a new academic period that has the same calendar year as the current academic period on the application.   
You can't use dynamic dates for student applications with an academic period classification of Fixed.   
This request cannot be processed due to a pending Change of Anticipated Start.   
Student Application must be active.   
An application already exists for this combination of Academic Unit, Academic Level & Program of Study.   
An application already exists for this combination of Academic Unit, Academic Level & Program of Study.   
There is already an Active Admissions Application for this Student with this Program of Study/Anticipated Start/External Application Identifier combination   
top
 

Student_ApplicationObject

part of: Change_Application_Anticipated_Start_Data, Submit_Change_Application_Anticipated_Start_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
 

Academic_PeriodObject

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

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top