Service Directory > v32.1 > Student_Records > Get_Learning_Outcomes
 

Operation: Get_Learning_Outcomes

Retrieves a single Learning Outcome by it's Reference ID, a set of Learning Outcomes closely matching the name, or returns all Learning Outcomes.


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

Get Learning Outcome Request Web Service Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Learning_Outcome_Request_References  [0..1]  The web service element containing the Reference ID of the requested Learning Outcome   
Request_Criteria [Choice]   Learning_Outcome_Request_Criteria  [0..1]  The web service element containing the Learning Outcome Name of the requested Learning Outcome.   
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. 
 
top
 

Response Element: Get_Learning_Outcomes_Response

Get Learning Outcome Web Service Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Learning_Outcome_Request_References  [0..1]  The web service element containing the Reference ID of the requested Learning Outcome   
Request_Criteria  Learning_Outcome_Request_Criteria  [0..1]  The web service element containing the Learning Outcome Name of the requested Learning Outcome.   
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_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_Outcome_Response_Data  [0..1]  Web Service Element containing the requested data.   
top
 

Learning_Outcome_Request_References

part of: Get_Learning_Outcomes_Request, Get_Learning_Outcomes_Response
The web service element containing the Reference ID of the requested Learning Outcome
 
Parameter name Type/Value Cardinality Description Validations
Learning_Outcome_Reference  Learning_OutcomeObject  [1..1]  The Reference ID of the Learning Outcome.   
top
 

Learning_OutcomeObject

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

Learning_OutcomeObjectID

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

part of: Get_Learning_Outcomes_Request, Get_Learning_Outcomes_Response
The web service element containing the Learning Outcome Name of the requested Learning Outcome.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Outcome_Name  string  [0..1]  The Learning Outcome Name.   
top
 

Response_Filter

part of: Get_Learning_Outcomes_Request, Get_Learning_Outcomes_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
 

Response_Results

part of: Get_Learning_Outcomes_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_Outcome_Response_Data

part of: Get_Learning_Outcomes_Response
Web Service Element containing the requested data.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Outcome  Learning_Outcome  [0..*]  Web Service Element containing a Learning Outcome.   
top
 

Learning_Outcome

part of: Learning_Outcome_Response_Data
Web Service Element containing a Learning Outcome.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Outcome_Reference  Learning_OutcomeObject  [0..1]  The Reference ID of the Learning Outcome.   
Learning_Outcome_Data  Learning_Outcome_Data  [0..*]  The Web Service element containing Learning Outcome data. 
Validation Description
At least 1 Competency doesn't have an effective-dated version covering the current date.   
One or more Competencies are not active.   
 
top
 

Learning_Outcome_Data

part of: Learning_Outcome
The Web Service element containing Learning Outcome data.
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [1..1]  The Learning Outcome Name. 
Validation Description
The Learning Outcome name cannot be changed.   
 
Has_Institution_Academic_Unit_Data  Has_Institution_Academic_Unit_Data  [1..1]  Has Institution Academic Unit Data   
Description  string  [1..1]  The Learning Outcome Description.   
Inactive  boolean  [0..1]  Whether a Learning Outcome is inactive or not.   
Competency_Reference  CompetencyObject  [0..*]  The Competencies linked to this Learning Outcome.   
Validation Description
At least 1 Competency doesn't have an effective-dated version covering the current date.   
One or more Competencies are not active.   
top
 

Has_Institution_Academic_Unit_Data

part of: Learning_Outcome_Data
Course Subject Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_UnitObject  [1..*]  Academic Unit Reference   
top
 

Academic_UnitObject

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

Academic_UnitObjectID

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

CompetencyObject

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

CompetencyObjectID

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

part of: Learning_OutcomeObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

CompetencyReferenceEnumeration

part of: CompetencyObjectID
Base Type
string
top