Service Directory > v31.2 > Learning > Get_Learning_Programs
 

Operation: Get_Learning_Programs

Retrieves Learning Programs.


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

Contains references to find and get learning programs and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Learning_Program_Request_References  [0..1]  Retrieves specific instances of learning programs and their associated data.   
Request_Criteria [Choice]   Learning_Program_Request_Criteria  [0..1]  Contains request criteria to get specific learning programs.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Learning_Program_Response_Group  [0..1]  Contains rules for formatting the response.   
top
 

Response Element: Get_Learning_Programs_Response

Contains references to learning programs and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Learning_Program_Request_References  [0..1]  Retrieves specific instances of learning programs and their associated data.   
Request_Criteria  Learning_Program_Request_Criteria  [0..1]  Contains request criteria to get specific learning programs.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Learning_Program_Response_Group  [0..1]  Contains rules for formatting the response.   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Learning_Program_Response_Data  [0..1]  Contains learning program data for each request reference. The data is current as of the dates in the response filter and doesn't include all historical information.   
top
 

Learning_Program_Request_References

part of: Get_Learning_Programs_Response, Get_Learning_Programs_Request
Retrieves specific instances of learning programs and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Program_Reference  Learning_ProgramObject  [1..*]  References the learning programs in the request. The IDs correspond to the titles of the programs.   
top
 

Learning_ProgramObject

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

Learning_ProgramObjectID

part of: Learning_ProgramObject
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  [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_Program_Request_Criteria

part of: Get_Learning_Programs_Response, Get_Learning_Programs_Request
Contains request criteria to get specific learning programs.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Learning_Programs_Response, Get_Learning_Programs_Request
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Learning_Program_Response_Group

part of: Get_Learning_Programs_Response, Get_Learning_Programs_Request
Contains rules for formatting the response.
 
Parameter name Type/Value Cardinality Description Validations
Exclude_Program_Image_Data  boolean  [0..1]  Indicates that Image data should not be included in the response.   
top
 

Response_Results

part of: Get_Learning_Programs_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Learning_Program_Response_Data

part of: Get_Learning_Programs_Response
Contains learning program data for each request reference. The data is current as of the dates in the response filter and doesn't include all historical information.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Program  Learning_Program  [0..*]  Contains learning program data for each request reference. The data is current as of the dates in the response filter and doesn't include all historical information.   
top
 

Learning_Program

part of: Learning_Program_Response_Data
Contains learning program data for each request reference. The data is current as of the dates in the response filter and doesn't include all historical information.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Program_Reference  Learning_ProgramObject  [0..1]  Reference for a learning program.   
Learning_Program_Data  Learning_Program_Data  [0..1]  Documentation Contains detailed information about a learning program. 
Validation Description
You need to set Requires Successful Completion on at least 1 item.   
Content order values must be unique.   
You can't associate inactive topics with a program. Enter 1 or more active topics.   
Title must be unique.   
Inactive sales items are not allowed   
You can't add inactive content items to the program.   
In Progress status cannot be added to Learning Programs.   
Enter an Effective Date that's on or after today's date.   
Security Categories can only be added to Programs if the Tenant Set Up flag for 'Enable Security Category' or 'Enable Topic and Security Category' is selected.   
Reference IDs must be unique.   
You can't add duplicate items to a program. Remove duplicate items before you submit.   
Add 1 or more content items.   
 
top
 

Learning_Program_Data

part of: Learning_Program
Documentation Contains detailed information about a learning program.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Specifies ID   
Effective_Date  date  [1..1]  Specifies Effective Date   
Version_Label  string  [0..1]  Specifies Learning Course Version   
Version_Notes  RichText  [0..1]  Specifies Learning Course Version Notes   
Inactive  boolean  [0..1]  Specifies Inactive   
Program_Title  string  [1..1]  Specifies Learning Course Title (Translatable)   
Skill_Level_Reference  Learning_Skill_LevelObject  [0..1]  Specifies Course Skill Level   
Description  RichText  [1..1]  Specifies Description   
Program_Number  string  [0..1]  Specifies Program Number   
Sales_Item_Reference  Sales_ItemObject  [0..*]  Specifies Sales Item Reference   
Topic_Reference  Learning_TopicObject  [1..*]  Specifies Topic Referece   
Security_Category_Reference  Learning_Security_CategoryObject  [0..*]  Specifies Security Category Reference   
Registrable_Status_Reference  Learning_Registerable_StatusObject  [1..1]  Specifies Registrable Status Reference   
Contact_Person_Reference  WorkerObject  [0..*]  Specifies Contact Person Reference   
Program_Image_Data  Learning_Image_Data  [0..1]  Specifies Program Image Data 
Validation Description
Content Type not supported. An image is required.   
 
Exclude_from_Recommendations  boolean  [0..1]  Specifies Exclude from Recommendations   
Program_Content_Data  Learning_Program_Content_Data  [1..*]  Specifies Learning Program Data 
Validation Description
If you set Recognize Previous Completions, you must set All Previous Completions, As-Of Date, or Within Date Range.  If you set Recognize Previous Completions, you must set All Previous Completions, As-Of Date, or Within Date Range. 
If you set Within Date Range, you must enter a Start Date and an End Date.  If you set Within Date Range, you must enter a Start Date and an End Date. 
Enter an End Date for previous completions that's on or before the current date.  Enter an End Date for previous completions that's on or before the current date. 
Enter a Start Date that's on or before the End Date.  Enter a Start Date that's on or before the End Date. 
If you set As-Of Date, you must enter a Start Date.  If you set As-Of Date, you must enter a Start Date. 
You must set Recognize Previous Completions, before you can set All Previous Completions, As-Of Date or Within Date Range.  You must set Recognize Previous Completions, before you can set All Previous Completions, As-Of Date or Within Date Range. 
Enter a Start Date for previous completions that's on or before the current date.  Enter a Start Date for previous completions that's on or before the current date. 
You can't set Recognize Previous Completions for stand-alone lesson content, but Workday automatically recognizes these completions.  You can't set Recognize Previous Completions for stand-alone lesson content, but Workday automatically recognizes these completions. 
If you set As-Of Date, you can't enter an End Date.  If you set As-Of Date, you can't enter an End Date. 
If you set All Previous Completions, you can't enter a Start Date or an End Date.  If you set All Previous Completions, you can't enter a Start Date or an End Date. 
 
Validation Description
You need to set Requires Successful Completion on at least 1 item.   
Content order values must be unique.   
You can't associate inactive topics with a program. Enter 1 or more active topics.   
Title must be unique.   
Inactive sales items are not allowed   
You can't add inactive content items to the program.   
In Progress status cannot be added to Learning Programs.   
Enter an Effective Date that's on or after today's date.   
Security Categories can only be added to Programs if the Tenant Set Up flag for 'Enable Security Category' or 'Enable Topic and Security Category' is selected.   
Reference IDs must be unique.   
You can't add duplicate items to a program. Remove duplicate items before you submit.   
Add 1 or more content items.   
top
 

Learning_Skill_LevelObject

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

Learning_Skill_LevelObjectID

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

Sales_ItemObject

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

Sales_ItemObjectID

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

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

Learning_TopicObjectID

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

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

Learning_Security_CategoryObjectID

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

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

Learning_Registerable_StatusObjectID

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

WorkerObject

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

Learning_Image_Data

part of: Learning_Program_Data
Contains the cover image for the course.
 
Parameter name Type/Value Cardinality Description Validations
Image_ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
File_Name  string (255)   [1..1]  Text attribute that identifies the filename of the attachment.   
Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
Image  base64Binary  [1..1]  File content in binary format.   
Validation Description
Content Type not supported. An image is required.   
top
 

Learning_Program_Content_Data

part of: Learning_Program_Data
Contains information about the learning program content Data
 
Parameter name Type/Value Cardinality Description Validations
Content_Order  decimal (4, 0) >0   [1..1]  Specifies the lesson Order   
Requires_Successful_Completion  boolean  [0..1]  Specifies Requires Successful Completion   
Blended_Course_Reference [Choice]   Multi_Course_TemplateObject  [1..1]  Specifies Blended Course for Learning Program   
Digital_Course_Reference [Choice]   Enrollable_Course_BehaviourObject  [1..1]  Specifies Digital Course for Learning Program   
Lesson_Reference [Choice]   Learning_Lesson_BehaviourObject  [1..1]  Specifies Lesson for Learning Program   
Recognize_Previous_Completion  boolean  [0..1]  Indicates whether to recognize previous completions.   
All_Previous_Completions [Choice]   boolean  [0..1]  Indicates whether to recognize all previous completions.   
As-Of_Date [Choice]   boolean  [0..1]  Indicates whether to recognize previous completions as of a specific start date.   
Within_Date_Range [Choice]   boolean  [0..1]  Indicates whether to recognize previous completions within a specific date range.   
Start_Date  date  [0..1]  References the start date for recognizing previous completions.   
End_Date  date  [0..1]  References the end date for recognizing previous completions.   
Validation Description
If you set Recognize Previous Completions, you must set All Previous Completions, As-Of Date, or Within Date Range.  If you set Recognize Previous Completions, you must set All Previous Completions, As-Of Date, or Within Date Range. 
If you set Within Date Range, you must enter a Start Date and an End Date.  If you set Within Date Range, you must enter a Start Date and an End Date. 
Enter an End Date for previous completions that's on or before the current date.  Enter an End Date for previous completions that's on or before the current date. 
Enter a Start Date that's on or before the End Date.  Enter a Start Date that's on or before the End Date. 
If you set As-Of Date, you must enter a Start Date.  If you set As-Of Date, you must enter a Start Date. 
You must set Recognize Previous Completions, before you can set All Previous Completions, As-Of Date or Within Date Range.  You must set Recognize Previous Completions, before you can set All Previous Completions, As-Of Date or Within Date Range. 
Enter a Start Date for previous completions that's on or before the current date.  Enter a Start Date for previous completions that's on or before the current date. 
You can't set Recognize Previous Completions for stand-alone lesson content, but Workday automatically recognizes these completions.  You can't set Recognize Previous Completions for stand-alone lesson content, but Workday automatically recognizes these completions. 
If you set As-Of Date, you can't enter an End Date.  If you set As-Of Date, you can't enter an End Date. 
If you set All Previous Completions, you can't enter a Start Date or an End Date.  If you set All Previous Completions, you can't enter a Start Date or an End Date. 
top
 

Multi_Course_TemplateObject

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

Multi_Course_TemplateObjectID

part of: Multi_Course_TemplateObject
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  [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
 

Enrollable_Course_BehaviourObject

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

Enrollable_Course_BehaviourObjectID

part of: Enrollable_Course_BehaviourObject
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  [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_Lesson_BehaviourObject

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

Learning_Lesson_BehaviourObjectID

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

part of: Learning_ProgramObjectID
Base Type
string
top
 

RichText

part of: Learning_Program_Data, Learning_Program_Data
Base Type
string
top
 

Learning_Skill_LevelReferenceEnumeration

part of: Learning_Skill_LevelObjectID
Base Type
string
top
 

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top
 

Learning_TopicReferenceEnumeration

part of: Learning_TopicObjectID
Base Type
string
top
 

Learning_Security_CategoryReferenceEnumeration

part of: Learning_Security_CategoryObjectID
Base Type
string
top
 

Learning_Registerable_StatusReferenceEnumeration

part of: Learning_Registerable_StatusObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Multi_Course_TemplateReferenceEnumeration

part of: Multi_Course_TemplateObjectID
Base Type
string
top
 

Enrollable_Course_BehaviourReferenceEnumeration

part of: Enrollable_Course_BehaviourObjectID
Base Type
string
top
 

Learning_Lesson_BehaviourReferenceEnumeration

part of: Learning_Lesson_BehaviourObjectID
Base Type
string
top