Service Directory > v32.1 > Student_Records > Get_Completion_Honor_or_Award_Rule_Sets
 

Operation: Get_Completion_Honor_or_Award_Rule_Sets

Returns information for Completion Honor or Award Rule Sets specified in the request. If the request does not specify a Completion Honor or Award Rule Set, this operation returns information for all Completion Honor or Award Rule Sets.


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

Get Completion Honor or Award Rule Sets Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Completion_Honor_or_Award_Rule_Set_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Completion_Honor_or_Award_Rule_Set_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Completion_Honor_or_Award_Rule_Sets_Response

Get Completion Honor or Award Rule Sets Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Completion_Honor_or_Award_Rule_Set_Request_References  [0..1]  Request References   
Request_Criteria  Completion_Honor_or_Award_Rule_Set_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Completion_Honor_or_Award_Rule_Set_Response_Data  [0..1]  Response Data   
top
 

Completion_Honor_or_Award_Rule_Set_Request_References

part of: Get_Completion_Honor_or_Award_Rule_Sets_Response, Get_Completion_Honor_or_Award_Rule_Sets_Request
Completion Honor or Award Rule Set Request References
 
Parameter name Type/Value Cardinality Description Validations
Completion_Honor_or_Award_Rule_Set_Reference  Completion_Honor_or_Award_Rule_SetObject  [1..*]  Completion Honor or Award Rule Sets   
top
 

Completion_Honor_or_Award_Rule_SetObject

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

Completion_Honor_or_Award_Rule_SetObjectID

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

Completion_Honor_or_Award_Rule_Set_Request_Criteria

part of: Get_Completion_Honor_or_Award_Rule_Sets_Response, Get_Completion_Honor_or_Award_Rule_Sets_Request
Completion Honor or Award Rule Set Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Completion_Honor_or_Award_Rule_Sets_Response, Get_Completion_Honor_or_Award_Rule_Sets_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
 

Response_Results

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

Completion_Honor_or_Award_Rule_Set_Response_Data

part of: Get_Completion_Honor_or_Award_Rule_Sets_Response
Completion Honor or Award Rule Set Response Data
 
Parameter name Type/Value Cardinality Description Validations
Completion_Honor_or_Award_Rule_Set  Completion_Honor_or_Award_Rule_Set  [0..*]  Completion Honor or Award Rule Set   
top
 

Completion_Honor_or_Award_Rule_Set

part of: Completion_Honor_or_Award_Rule_Set_Response_Data
Completion Honor or Award Rule Set
 
Parameter name Type/Value Cardinality Description Validations
Completion_Honor_or_Award_Rule_Set_Reference  Completion_Honor_or_Award_Rule_SetObject  [0..1]  Completion Honor or Award Rule Set   
Completion_Honor_or_Award_Rule_Set_Data  Completion_Honor_or_Award_Rule_Set_Data  [0..1]  Completion Honor or Award Rule Set Data 
Validation Description
Enter a unique ID for each rule.   
Enter a unique Order for each rule.   
Enter a unique Eligibility Rule for each rule.   
 
top
 

Completion_Honor_or_Award_Rule_Set_Data

part of: Completion_Honor_or_Award_Rule_Set
Completion Honor or Award Rule Set Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Completion Honor or Award Rule Set Reference ID   
Completion_Honor_or_Award_Rule_Set_Name  string  [1..1]  Completion Honor or Award Rule Set Name   
Completion_Honor_or_Award_Rule_Data  Completion_Honor_or_Award_Rule_Data  [1..*]  Completion Honor or Award Rule Data 
Validation Description
Student eligibility rule must be one of the following types: Course Requirement, Grade Requirement, Unit Requirement, Student Cohort, Program of Study, Combination, Student Condition with Academic Record business object.   
 
Validation Description
Enter a unique ID for each rule.   
Enter a unique Order for each rule.   
Enter a unique Eligibility Rule for each rule.   
top
 

Completion_Honor_or_Award_Rule_Data

part of: Completion_Honor_or_Award_Rule_Set_Data
Completion Honor or Award Rule Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Completion Honor or Award Rule Reference ID   
Order  string  [1..1]  Completion Honor or Award Order   
Program_Completion_Honor_or_Award_Reference  Program_Completion_Honor_or_AwardObject  [1..1]  Program Completion Honor or Award   
Eligibility_Rule_Reference  Student_Eligibility_RuleObject  [1..1]  Student Eligibility Rule   
Validation Description
Student eligibility rule must be one of the following types: Course Requirement, Grade Requirement, Unit Requirement, Student Cohort, Program of Study, Combination, Student Condition with Academic Record business object.   
top
 

Program_Completion_Honor_or_AwardObject

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

Program_Completion_Honor_or_AwardObjectID

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

Student_Eligibility_RuleObject

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

Student_Eligibility_RuleObjectID

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

Completion_Honor_or_Award_Rule_SetReferenceEnumeration

part of: Completion_Honor_or_Award_Rule_SetObjectID
Base Type
string
top
 

Program_Completion_Honor_or_AwardReferenceEnumeration

part of: Program_Completion_Honor_or_AwardObjectID
Base Type
string
top
 

Student_Eligibility_RuleReferenceEnumeration

part of: Student_Eligibility_RuleObjectID
Base Type
string
top