Service Directory > v33.1 > Learning > Get_Equivalency_Rules
 

Operation: Get_Equivalency_Rules

Retrieves Equivalency Rules


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

Contains references to find and get equivalency rules and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Equivalency_Rule_Request_References  [0..1]  Retrieves specific instances of equivalency rules and their associated data.   
Request_Criteria [Choice]   Equivalency_Rule_Request_Criteria  [0..1]  Contains request criteria to get specific equivalency rules.   
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_Equivalency_Rules_Response

Contains references to equivalency rules and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Equivalency_Rule_Request_References  [0..1]  Retrieves specific instances of equivalency rules and their associated data.   
Request_Criteria  Equivalency_Rule_Request_Criteria  [0..1]  Contains request criteria to get specific equivalency rules.   
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  Equivalency_Rule_Response_Data  [0..1]  Contains equivalency rule 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
 

Equivalency_Rule_Request_References

part of: Get_Equivalency_Rules_Response, Get_Equivalency_Rules_Request
Retrieves specific instances of equivalency rules and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Equivalency_Rule_Reference  Equivalency_RuleObject  [1..*]  References the equivalency rules in the request.   
top
 

Equivalency_RuleObject

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

Equivalency_RuleObjectID

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

Equivalency_Rule_Request_Criteria

part of: Get_Equivalency_Rules_Response, Get_Equivalency_Rules_Request
Contains request criteria to get specific equivalency rules.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Equivalency_Rules_Response, Get_Equivalency_Rules_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Equivalency_Rules_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Equivalency_Rule_Response_Data

part of: Get_Equivalency_Rules_Response
Contains equivalency rule 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
Equivalency_Rule  Equivalency_Rule  [0..*]  Contains equivalency rule 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
 

Equivalency_Rule

part of: Equivalency_Rule_Response_Data
Contains equivalency rule 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
Equivalency_Rule_Reference  Equivalency_RuleObject  [0..1]  Reference for an equivalency rule.   
Equivalency_Rule_Data  Equivalency_Rule_Data  [0..1]  Contains detailed information about an equivalency rule. 
Validation Description
Specify different source and target courses for the equivalency rule.   
You need to specify a course as the target of the equivalency rule.   
You can't change the content associated with this rule.   
Specify an Effective From date that's before the Effective To date.   
Workday automatically timestamps the inactivation date. You can't change the date.   
You need to specify a course as the source of the equivalency rule.   
You need to set the rule to active before you can change its values.   
You can't change the direction of the rule.   
You can't create two-way relationships for group equivalency rules.   
Learning equivalency rules must have 1 or more Source and Target values, or multiple Content values, but not both.   
You must include 2 or more content items in the group equivalency rule.   
 
top
 

Equivalency_Rule_Data

part of: Equivalency_Rule
Contains detailed information about an equivalency rule.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the equivalency rule.   
Source_Equivalency_Content_Reference  Equivalency_Enabled_ContentObject  [0..*]  Source content for the equivalency rule.   
Target_Equivalency_Content_Reference  Equivalency_Enabled_ContentObject  [0..*]  Target content for the equivalency rule.   
Group_Equivalency_Content_Reference  Equivalency_Enabled_ContentObject  [0..*]  Group content for the equivalency rule.   
Two-Way  boolean  [0..1]  Indicates whether the equivalency rule is two-way or singular.   
Effective_Date_From  date  [1..1]  Effective from date for the equivalency rule.   
Effective_Date_To  date  [0..1]  Effective to date for the equivalency rule.   
Inactive  boolean  [0..1]  Indicates whether the equivalency rule is inactive.   
Inactivation_Date  date  [0..1]  Inactivation date for the equivalency rule.   
Display_Equivalency_Records_on_Learning_History  boolean  [0..1]  Indicates whether the equivalency records are to appear on Learning History.   
Display_Equivalency_Options_on_Course  boolean  [0..1]  Indicates whether the equivalency options are to appear on Learning Course.   
Validation Description
Specify different source and target courses for the equivalency rule.   
You need to specify a course as the target of the equivalency rule.   
You can't change the content associated with this rule.   
Specify an Effective From date that's before the Effective To date.   
Workday automatically timestamps the inactivation date. You can't change the date.   
You need to specify a course as the source of the equivalency rule.   
You need to set the rule to active before you can change its values.   
You can't change the direction of the rule.   
You can't create two-way relationships for group equivalency rules.   
Learning equivalency rules must have 1 or more Source and Target values, or multiple Content values, but not both.   
You must include 2 or more content items in the group equivalency rule.   
top
 

Equivalency_Enabled_ContentObject

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

Equivalency_Enabled_ContentObjectID

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

Equivalency_RuleReferenceEnumeration

part of: Equivalency_RuleObjectID
Base Type
string
top
 

Equivalency_Enabled_ContentReferenceEnumeration

part of: Equivalency_Enabled_ContentObjectID
Base Type
string
top