Service Directory > v31.2 > Learning > Put_Learning_Enrollment
 

Operation: Put_Learning_Enrollment

Updates or creates legacy enrollments.


@ - 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: Put_Learning_Enrollment_Request

Contains all the request data to add or update legacy enrollments.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Learning_Enrollment_Reference  Learning_EnrollmentObject  [0..1]  Identifies enrollments using unique references for updates. Leave blank when creating enrollments.   
Learning_Enrollment_Data  Learning_Enrollment_Data  [1..1]  Contains detailed data about the enrollment. 
Validation Description
The Enrollment must be successfully complete for the Expiration Date to apply  The Enrollment must be successfully complete for the Expiration Date to apply 
Registration Date must be before Completion Date  When adding a learning enrollment, the Registration Date must be before the Completion Date. 
Completion Date must be in the past  When adding or updating a learning enrollment, the Completion Date must be in the past. 
You can't rescind the enrollment because you haven't submitted it yet.  When rescinding, only existing Enrollments are supported. 
You can't rescind this enrollment. You can only rescind imported enrollments.  Non-imported enrollments cannot be rescinded. 
You can't update or rescind this enrollment because it's already rescinded.  Rescinded enrollments cannot be updated. 
If Track Attendance is set on the course offering, the Attendance Status Reference is required for the enrollment.   
Worker is a Future Hire  Workday doesn't currently support pre-hire learning enrollments. 
Invalid Learner for Enrollment  When updating an enrollment, the learner provided in the data element must be the same as the learner 
Workday enables you to track grades and scores only at the course level, so you can't specify a score on the enrollment for the program.  When the enrollment is for programs then the enrollment cannot have a score as programs don't have them. 
Workday enables you to track grades and scores only at the course level, so you can't specify a grade on the enrollment for the program.  When the enrollment is for programs then the enrollment cannot have a grade as programs don't have them. 
Workday enables you to specify an expiry period only at the course level, so you cannot specify an expiration date or duration on the enrollment for the program.  When the enrollment is for a program, then it cannot have an expiration period, as programs don't have them. 
The enrollment for the program must have a completion date.  When the enrollment is for a program then it must have a completion date. 
If Make Lesson Mandatory is set on 1 or more lessons, the course enrollment must have a Completion Date. You can't specify a Completion Date if there aren't any mandatory lessons.   
The Learning Content Reference cannot be changed when updating a complete enrolment.   
The learner isn't eligible to enroll in the learning content.   
The version of the learning content on the enrollment must match an existing version.   
You cannot specify an Expiration Date for the course enrollment if there are no mandatory lessons or if the Completion Date is not set.   
 
top
 

Response Element: Put_Learning_Enrollment_Response

Contains the references for the enrollments created or updated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Learning_Enrollment_Reference  Learning_EnrollmentObject  [0..1]  References the created or updated enrollments.   
top
 

Learning_EnrollmentObject

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

Learning_EnrollmentObjectID

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

Learning_Enrollment_Data

part of: Put_Learning_Enrollment_Request
Contains detailed data about the enrollment.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the enrollment.   
Learning_Content_Reference  Learning_RegisterableObject  [1..1]  References the program, course, or course offering the enrollment is for.   
Learner_Reference  RoleObject  [1..1]  References the learner for the enrollment.   
Registered_Date  date  [0..1]  Date of enrollment registration into the course or course offering.   
Learning_Enrollment_Completion_Date  dateTime  [0..1]  Date the enrollment for the course or course offering was completed.   
Overall_Course_Score  decimal (9, 3) >0   [0..1]  Score for the course   
Learning_Grade_Reference  Learning_GradeObject  [0..1]  References the grade for the enrollment.   
Attendance_Status_Reference  Attendance_StatusObject  [0..1]  References the Attendance Status for the enrollment.   
Version_Label  string  [0..1]  Version Label of the Course Offering   
Expiration_Date  date  [0..1]  Expiration Date for Learning Enrollment   
Rescind_Enrollment  boolean  [0..1]  Rescinds the enrollment   
Validation Description
The Enrollment must be successfully complete for the Expiration Date to apply  The Enrollment must be successfully complete for the Expiration Date to apply 
Registration Date must be before Completion Date  When adding a learning enrollment, the Registration Date must be before the Completion Date. 
Completion Date must be in the past  When adding or updating a learning enrollment, the Completion Date must be in the past. 
You can't rescind the enrollment because you haven't submitted it yet.  When rescinding, only existing Enrollments are supported. 
You can't rescind this enrollment. You can only rescind imported enrollments.  Non-imported enrollments cannot be rescinded. 
You can't update or rescind this enrollment because it's already rescinded.  Rescinded enrollments cannot be updated. 
If Track Attendance is set on the course offering, the Attendance Status Reference is required for the enrollment.   
Worker is a Future Hire  Workday doesn't currently support pre-hire learning enrollments. 
Invalid Learner for Enrollment  When updating an enrollment, the learner provided in the data element must be the same as the learner 
Workday enables you to track grades and scores only at the course level, so you can't specify a score on the enrollment for the program.  When the enrollment is for programs then the enrollment cannot have a score as programs don't have them. 
Workday enables you to track grades and scores only at the course level, so you can't specify a grade on the enrollment for the program.  When the enrollment is for programs then the enrollment cannot have a grade as programs don't have them. 
Workday enables you to specify an expiry period only at the course level, so you cannot specify an expiration date or duration on the enrollment for the program.  When the enrollment is for a program, then it cannot have an expiration period, as programs don't have them. 
The enrollment for the program must have a completion date.  When the enrollment is for a program then it must have a completion date. 
If Make Lesson Mandatory is set on 1 or more lessons, the course enrollment must have a Completion Date. You can't specify a Completion Date if there aren't any mandatory lessons.   
The Learning Content Reference cannot be changed when updating a complete enrolment.   
The learner isn't eligible to enroll in the learning content.   
The version of the learning content on the enrollment must match an existing version.   
You cannot specify an Expiration Date for the course enrollment if there are no mandatory lessons or if the Completion Date is not set.   
top
 

Learning_RegisterableObject

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

Learning_RegisterableObjectID

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

RoleObject

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

RoleObjectID

part of: RoleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Contact_ID, Academic_Person_ID, Applicant_ID, Beneficiary_ID, Business_Entity_Contact_ID, Candidate_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Dependent_ID, Emergency_Contact_ID, Employee_ID, Extended_Enterprise_Contact_Person_ID, Extended_Enterprise_Learner_ID, External_Committee_Member_ID, Former_Worker_ID, Instructor_ID, Learning_Instructor_ID, LearningUserName, Organization_Reference_ID, Recruiting_Agency_User_ID, RecruitingUserName, Region_Reference_ID, Service_Center_Representative_ID, Student_ID, Student_Proxy_ID, Student_Recruiter_ID, StudentUserName, SupplierUserName, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [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
 

Learning_GradeObject

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

Learning_GradeObjectID

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

Attendance_StatusObject

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

Attendance_StatusObjectID

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

Learning_EnrollmentReferenceEnumeration

part of: Learning_EnrollmentObjectID
Base Type
string
top
 

Learning_RegisterableReferenceEnumeration

part of: Learning_RegisterableObjectID
Base Type
string
top
 

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top
 

Learning_GradeReferenceEnumeration

part of: Learning_GradeObjectID
Base Type
string
top
 

Attendance_StatusReferenceEnumeration

part of: Attendance_StatusObjectID
Base Type
string
top