Service Directory > v31.2 > Learning > Get_Learning_Lessons
 

Operation: Get_Learning_Lessons

Retrieves standalone lessons.


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

Contains references to find and get lessons and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Learning_Lesson_Request_References  [0..1]  Retrieves specific instances of lessons and their associated data.   
Request_Criteria [Choice]   Learning_Lesson_Request_Criteria  [0..1]  Contains request criteria to get specific lessons.   
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_Course_Response_Group  [0..1]  Contains rules for formatting the response   
top
 

Response Element: Get_Learning_Lessons_Response

Contains references to lessons and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Learning_Lesson_Request_References  [0..1]  Container for Learning Lesson Request References   
Request_Criteria  Learning_Lesson_Request_Criteria  [0..1]  Retrieves specific instances of lessons and their associated data.   
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_Course_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_Lesson_Response_Data  [0..1]  Contains lesson 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_Lesson_Request_References

part of: Get_Learning_Lessons_Request, Get_Learning_Lessons_Response
Retrieves specific instances of lessons and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Lesson_Reference  Learning_LessonObject  [1..*]  References the lessons in the request.   
top
 

Learning_LessonObject

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

Learning_LessonObjectID

part of: Learning_LessonObject
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_Lesson_Request_Criteria

part of: Get_Learning_Lessons_Request, Get_Learning_Lessons_Response
Contains request criteria to get specific lessons.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Learning_Lessons_Request, Get_Learning_Lessons_Response
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_Course_Response_Group

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

Response_Results

part of: Get_Learning_Lessons_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_Lesson_Response_Data

part of: Get_Learning_Lessons_Response
Contains lesson 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_Lesson  Learning_Lesson  [0..*]  Contains lesson 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_Lesson

part of: Learning_Lesson_Response_Data
Contains lesson 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_Lesson_Reference  Learning_LessonObject  [0..1]  Reference for a lesson.   
Learning_Lesson_Data  Learning_Lesson_Data  [0..1]  Contains detailed information about a lesson. 
Validation Description
Lesson data is required.   
 
top
 

Learning_Lesson_Data

part of: Learning_Lesson
Contains detailed information about a lesson.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the lesson.   
Learning_Lesson_Content_Data  Learning_Lesson_Content_Data  [1..1]  Contains detailed information about the lesson. 
Validation Description
Learning Topic [topic] is not active.   
Media required for Media Course Lesson   
 
Learning_Image_Data  Learning_Image_Data  [0..1]  Contains the cover image for the course. 
Validation Description
Content Type not supported. An image is required.   
 
Validation Description
Lesson data is required.   
top
 

Learning_Lesson_Content_Data

part of: Learning_Lesson_Data
Contains detailed information about the lesson.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Lesson_Title  string  [1..1]  Title for the lesson.   
Learning_Lesson_Description  RichText  [1..1]  Description for the lesson.   
Inactive  boolean  [0..1]  Indicates whether the lesson is inactive.   
Exclude_from_Recommendations  boolean  [0..1]  Indicates whether the lesson is excluded from recommendations.   
Learning_Topic_Reference  Learning_TopicObject  [1..*]  References the topics for the lesson.   
Learning_Media_Reference  MediaObject  [1..1]  References the media for the lesson.   
Validation Description
Learning Topic [topic] is not active.   
Media required for Media Course Lesson   
top
 

Learning_TopicObject

part of: Learning_Lesson_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_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
 

MediaObject

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

MediaObjectID

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

part of: Learning_LessonObjectID
Base Type
string
top
 

RichText

part of: Learning_Lesson_Content_Data
Base Type
string
top
 

Learning_TopicReferenceEnumeration

part of: Learning_TopicObjectID
Base Type
string
top
 

MediaReferenceEnumeration

part of: MediaObjectID
Base Type
string
top