Service Directory > v32.1 > Student_Records > Submit_Program_Completion
 

Operation: Submit_Program_Completion

Web service task to submit a program for completion.


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

Submit Program Completion Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Student_Business_Process_Parameters  [0..1]  Student Business Process Parameters   
Submit_Program_Completion_Data  Submit_Program_Completion_Data  [1..1]  Submit Program Completion Data 
Validation Description
Submit either Student Reference or Academic Record Reference.   
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.   
You cannot complete a program to the reporting record while there are current or future Non-zero Disbursements or Waiver Payments.   
You can only complete a program when the primary program of study on the academic record has a status of either In Progress or Pending Completion.   
You can only complete a program when the primary program of study on the academic record has a status of either In Progress or Pending Completion.   
You cannot complete programs for a student that has future program of study changes.   
You cannot complete programs for a student that has future program of study changes.   
To complete the primary program of study, you must submit all addable programs of study for completion also.   
You can't submit a program of study for completion when the student doesn't have a record associated with it.   
You can't submit a program of study for completion when the student doesn't have a record associated with it.   
To complete the primary program of study, you must submit all addable programs of study for completion also.   
You cannot complete the program because the academic record has course registrations in progress.   
One or more Programs of Study are not eligible for completion because completion would result in an invalid calendar change.   
To complete an addable program of study, you must submit the primary program of study for completion also.   
To complete an addable program of study, you must submit the primary program of study for completion also.   
The Effective Conferral Date must be after the last program of study change for the student.   
The Effective Conferral Date must be after the last program of study change for the student.   
The Effective Conferral Date cannot be a future date.   
 
top
 

Response Element: Submit_Program_Completion_Response

Submit Program Completion Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Reference  StudentObject  [0..1]  Student   
Conferral_Date_Override  date  [0..1]  Conferral Date   
top
 

Student_Business_Process_Parameters

part of: Submit_Program_Completion_Request
Contains Business Process parameters such as "Autocomplete" and comment fields
 
Parameter name Type/Value Cardinality Description Validations
Automatically_Complete  boolean  [0..1]  Flag to automatically complete the Student Recruiting Campaign Business Process   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
top
 

Business_Process_Comment_Data

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

Submit_Program_Completion_Data

part of: Submit_Program_Completion_Request
Submit Program Completion Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Academic Record   
Program_of_Study_Reference  Program_of_StudyObject  [0..*]  Program of Study   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period   
Effective_Conferral_Date  date  [0..1]  Effective Conferral Date   
Conferral_Date_Override  date  [0..1]  Conferral Date   
Degree_GPA_Override  decimal (9, 6) >0   [0..1]  Degree GPA Override   
Validation Description
Submit either Student Reference or Academic Record Reference.   
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.   
You cannot complete a program to the reporting record while there are current or future Non-zero Disbursements or Waiver Payments.   
You can only complete a program when the primary program of study on the academic record has a status of either In Progress or Pending Completion.   
You can only complete a program when the primary program of study on the academic record has a status of either In Progress or Pending Completion.   
You cannot complete programs for a student that has future program of study changes.   
You cannot complete programs for a student that has future program of study changes.   
To complete the primary program of study, you must submit all addable programs of study for completion also.   
You can't submit a program of study for completion when the student doesn't have a record associated with it.   
You can't submit a program of study for completion when the student doesn't have a record associated with it.   
To complete the primary program of study, you must submit all addable programs of study for completion also.   
You cannot complete the program because the academic record has course registrations in progress.   
One or more Programs of Study are not eligible for completion because completion would result in an invalid calendar change.   
To complete an addable program of study, you must submit the primary program of study for completion also.   
To complete an addable program of study, you must submit the primary program of study for completion also.   
The Effective Conferral Date must be after the last program of study change for the student.   
The Effective Conferral Date must be after the last program of study change for the student.   
The Effective Conferral Date cannot be a future date.   
top
 

StudentObject

part of: Submit_Program_Completion_Data, Submit_Program_Completion_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  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: Submit_Program_Completion_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
 

Program_of_StudyObject

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

Academic_PeriodObject

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

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top