Service Directory > v32.1 > Admissions > Submit_Change_Application_Program_of_Study
 

Operation: Submit_Change_Application_Program_of_Study

Initiates the Business Process to change the Program of Study on a 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: Submit_Change_Application_Program_of_Study_Request

Request Element for Change Application Program of Study
 
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_Program_of_Study_Event_Data  Change_Application_Program_of_Study_Event_Data  [1..1]  Element Container for Change Application Program of Study Event 
Validation Description
New Program of Study cannot be Fast Path Enabled.   
There is already an Active Admissions Application for this Student with this Program of Study/Anticipated Start/External Application Identifier combination   
Enter a Date of Change that is on or before today and on or after the application date.   
Student Application must be active.   
A decision has already been rendered for this Student Application.   
The Program of Study must be valid for the Academic Period or Anticipated Start Date.   
A change of program of study for this application is already in progress.   
New Program(s) of Study must belong to the same Academic Unit and Academic Level as the old Program(s) of Study.   
There cannot be two Student Application Program of Study Lines with the same order.   
You can't edit the secondary record of a match and merge pair after it has been merged.   
 
top
 

Response Element: Submit_Change_Application_Program_of_Study_Response

Response Element for Change Application Program of Study
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Application_Reference  Student_ApplicationObject  [0..1]  The student application for change of program of study.   
top
 

Business_Process_Parameters

part of: Submit_Change_Application_Program_of_Study_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_Program_of_Study_Event_Data

part of: Submit_Change_Application_Program_of_Study_Request
Element Container for Change Application Program of Study Event Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Reference  Student_ApplicationObject  [1..1]  The student application to change program of study.   
Student_Application_Program_of_Study_Line_Data  Student_Application_Program_of_Study_Line_Data  [1..*]  This element represents one line in the Program of Study Grid. 
Validation Description
Program Focus is required for [POS]   
The Program Focus must be Approved.   
The Program Focus must have a Program of Study Type with Category of 'Program Focus'.   
The Program Focus provided is not configured for the Program of Study.   
You must select a Program of Study that has a Stand Alone Program of Study Type.   
 
Change_Application_Program_of_Study_Date  date  [0..1]  The date for the student application's change of program of study.   
Validation Description
New Program of Study cannot be Fast Path Enabled.   
There is already an Active Admissions Application for this Student with this Program of Study/Anticipated Start/External Application Identifier combination   
Enter a Date of Change that is on or before today and on or after the application date.   
Student Application must be active.   
A decision has already been rendered for this Student Application.   
The Program of Study must be valid for the Academic Period or Anticipated Start Date.   
A change of program of study for this application is already in progress.   
New Program(s) of Study must belong to the same Academic Unit and Academic Level as the old Program(s) of Study.   
There cannot be two Student Application Program of Study Lines with the same order.   
You can't edit the secondary record of a match and merge pair after it has been merged.   
top
 

Student_ApplicationObject

part of: Change_Application_Program_of_Study_Event_Data, Submit_Change_Application_Program_of_Study_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_Program_of_Study_Line_Data

part of: Change_Application_Program_of_Study_Event_Data
This element represents one line in the Program of Study Grid.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Application Program of Study Line Data   
Order  string (6)   [1..1]  The order of this Program of Study Line in the POS grid 
Validation Description
You cannot change the Order of Student Application Program of Student Lines on an existing application.   
 
Program_of_Study_Reference  Program_of_StudyObject  [1..1]  The Program of Study on this line in the POS grid 
Validation Description
You cannot change the Program of Study for an existing Application.   
 
Program_Focus_Reference  Program_of_StudyObject  [0..1]  The Program Focus on this line in the POS grid 
Validation Description
You cannot change the Program Focus for an existing application.   
 
Validation Description
Program Focus is required for [POS]   
The Program Focus must be Approved.   
The Program Focus must have a Program of Study Type with Category of 'Program Focus'.   
The Program Focus provided is not configured for the Program of Study.   
You must select a Program of Study that has a Stand Alone Program of Study Type.   
top
 

Program_of_StudyObject

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

Program_of_StudyObjectID

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

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top