Service Directory > v32.1 > Student_Records > Submit_Add_Program_of_Study
 

Operation: Submit_Add_Program_of_Study

Add a Program of Study to a Matriculated Student via the Web Service.


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

Submit Add Program of Study Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Business Process Parameters   
Add_Program_of_Study_Event_Data  Add_Program_of_Study_Event_Data  [1..1]  Add Program of Study Event Data 
Validation Description
You can only add programs when you have at least 1 program in progress.   
Student has more than one Academic Record. Please submit Academic Record Reference. If using a version prior to v30.0, please update to the latest version.   
Submit either Student Reference or Academic Record Reference.   
You can't add a program of study for a student when any of these events are in progress: Add, Change, Make Primary, or Remove Program of Study, Change Expected Program Completion Date, Institutional Withdrawal, Leave of Absence, and Conferral Request.   
 
top
 

Response Element: Submit_Add_Program_of_Study_Response

Submit Add Program of Study Event Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Academic_Record_Reference  Academic_RecordObject  [0..1]  Contains reference to the Academic Record   
top
 

Business_Process_Parameters

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

Add_Program_of_Study_Event_Data

part of: Submit_Add_Program_of_Study_Request
Add Program of Study Event Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Contain Student with Student Record Reference   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Contains Academic Record   
Valid_Program_of_Study_Add_Data  Valid_Program_of_Study_Add_Data  [1..1]  Valid Program of Study Add Data 
Validation Description
Enter a program of study type that corresponds to the new Program of Study.   
Enter a program of study that has not been declared.   
Enter an approved program of study.   
Unable to add a Program Focus to a Student without the Parent Program of Study.   
Expected Completion Date must be greater than then the Declare Date.   
Program of Study being added is not Addable to Student's Primary Program of Study   
 
Validation Description
You can only add programs when you have at least 1 program in progress.   
Student has more than one Academic Record. Please submit Academic Record Reference. If using a version prior to v30.0, please update to the latest version.   
Submit either Student Reference or Academic Record Reference.   
You can't add a program of study for a student when any of these events are in progress: Add, Change, Make Primary, or Remove Program of Study, Change Expected Program Completion Date, Institutional Withdrawal, Leave of Absence, and Conferral Request.   
top
 

StudentObject

part of: Add_Program_of_Study_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  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: Add_Program_of_Study_Event_Data, Submit_Add_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  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
 

Valid_Program_of_Study_Add_Data

part of: Add_Program_of_Study_Event_Data
Add Program of Study Event Data
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Type_Reference  Program_of_Study_TypeObject  [1..1]  Contain Program of Study Type Reference   
Program_of_Study_Reference  Program_of_StudyObject  [1..1]  Contain program of Study Reference   
Declare_Date  date  [1..1]  Contain Student Program of Study Record Declare Date   
Expected_Completion_Date  date  [1..1]  Contain Student Program of Study Record Expected Completion Date   
Validation Description
Enter a program of study type that corresponds to the new Program of Study.   
Enter a program of study that has not been declared.   
Enter an approved program of study.   
Unable to add a Program Focus to a Student without the Parent Program of Study.   
Expected Completion Date must be greater than then the Declare Date.   
Program of Study being added is not Addable to Student's Primary Program of Study   
top
 

Program_of_Study_TypeObject

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

Program_of_Study_TypeObjectID

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

Program_of_StudyObject

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

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Program_of_Study_TypeReferenceEnumeration

part of: Program_of_Study_TypeObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top