Service Directory > v32.1 > Student_Records > Get_Completion_Honor_or_Award_Policies
 

Operation: Get_Completion_Honor_or_Award_Policies

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


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

Get Completion Honor or Award Policies Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Completion_Honor_or_Award_Policy_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Completion_Honor_or_Award_Policy_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_Policies_Response

Get Completion Honor or Award Policies Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Completion_Honor_or_Award_Policy_Request_References  [0..1]  Completion Honor or Award Policy Request References   
Request_Criteria  Completion_Honor_or_Award_Policy_Request_Criteria  [0..1]  Completion Honor or Award Policy 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_Policy_Response_Data  [0..1]  Response Data   
top
 

Completion_Honor_or_Award_Policy_Request_References

part of: Get_Completion_Honor_or_Award_Policies_Request, Get_Completion_Honor_or_Award_Policies_Response
Completion Honor or Award Policy Request References
 
Parameter name Type/Value Cardinality Description Validations
Completion_Honor_or_Award_Policy_Reference  Completion_Honor_or_Award_PolicyObject  [1..*]  Completion Honor or Award Policy Reference   
top
 

Completion_Honor_or_Award_PolicyObject

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

Completion_Honor_or_Award_PolicyObjectID

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

part of: Get_Completion_Honor_or_Award_Policies_Request, Get_Completion_Honor_or_Award_Policies_Response
Completion Honor or Award Policy Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Completion_Honor_or_Award_Policies_Request, Get_Completion_Honor_or_Award_Policies_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_Completion_Honor_or_Award_Policies_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_Policy_Response_Data

part of: Get_Completion_Honor_or_Award_Policies_Response
Completion Honor or Award Policy Response Data
 
Parameter name Type/Value Cardinality Description Validations
Completion_Honor_or_Award_Policy  Completion_Honor_or_Award_Policy  [0..*]  Completion Honor or Award Policy   
top
 

Completion_Honor_or_Award_Policy

part of: Completion_Honor_or_Award_Policy_Response_Data
Completion Honor or Award Policy Response Data
 
Parameter name Type/Value Cardinality Description Validations
Completion_Honor_or_Award_Policy_Reference  Completion_Honor_or_Award_PolicyObject  [0..1]  Completion Honor or Award Policy Reference   
Completion_Honor_or_Award_Policy_Data  Academic_Unit_Policy_Data  [1..1]  Completion Honor or Award Policy Data   
top
 

Academic_Unit_Policy_Data

part of: Completion_Honor_or_Award_Policy
Element Container for Academic Unit Policy Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Academic Unit Policy ID   
Effective_Date  date  [1..1]  Effective Date   
Academic_Division_Configuration_or_Program_of_Study_Reference  AU_Policy_Academic_Division_Configuration_or_Program_of_Study_Data  [1..1]  Academic Division Configuration or Program of Study Reference 
Validation Description
Select an Academic Unit/Academic Level combination or a Program of Study.   
Select a valid Academic Unit and Academic Level combination.   
Program of Study is not effective as of the provided Snapshot Effective Date.   
 
Academic_Unit_Policy_Rule_Set_Reference  Academic_Unit_Policy_Rule_SetObject  [1..1]  Academic Unit Policy Rule Set Reference   
top
 

AU_Policy_Academic_Division_Configuration_or_Program_of_Study_Data

part of: Academic_Unit_Policy_Data
Element containing data for Academic Division Configurations or Programs of Study. Either a Program of Study must be selected or both an Academic Unit and an Academic Level. This container is used for Academic Unit Policy web service tasks.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [0..1]  Academic Unit Reference   
Academic_Level_Reference  Academic_LevelObject  [0..1]  Academic Level Secured Reference for Web Service   
Program_of_Study_Reference  Program_of_StudyObject  [0..1]  Program of Study Reference   
Validation Description
Select an Academic Unit/Academic Level combination or a Program of Study.   
Select a valid Academic Unit and Academic Level combination.   
Program of Study is not effective as of the provided Snapshot Effective Date.   
top
 

Academic_Curricular_DivisionObject

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

Academic_Curricular_DivisionObjectID

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

Academic_LevelObject

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

Academic_LevelObjectID

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

Program_of_StudyObject

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

Program_of_StudyObjectID

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

Academic_Unit_Policy_Rule_SetObject

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

Academic_Unit_Policy_Rule_SetObjectID

part of: Academic_Unit_Policy_Rule_SetObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Standing_Rule_Set_ID, API_Testing_Academic_Unit_Policy_Rule_Set_ID, Application_Evaluation_Configuration_Rule_Set_ID, Charge_Assessment_Reaction_Rule_Set_ID, Class_Standing_Rule_Set_ID, COD_Routing_ID_Rule_Set_ID, College_Board_College_Code_ID, Completion_Honor_or_Award_Rule_Set_ID, Cost_of_Attendance_Reaction_Rule_Set_ID, Course_Attempt_Limit_for_Student_Charges_Rule_Set_ID, Course_Attempt_Limit_Rule_Set_ID, Course_Repeat_Rule_Set_ID, Course_Unit_Type_Rule_Set_ID, Course_Waitlist_Rule_Set_ID, EFC_Duration_Rule_Set_ID, Enrollment_Access_Rule_Set_ID, Enrollment_Unit_Limit_Rule_Set_ID, Federal_School_Code_Rule_Set_ID, Federal_Student_Aid_Program_Rule_Set_ID, Financial_Aid_Communication_Rule_Set_ID, Financial_Aid_Shopping_Sheet_Configuration_ID, Load_Status_Rule_Set_ID, Merit_Packaging_Reaction_Rule_Set_ID, Need_Packaging_Reaction_Rule_Set_ID, Program_Completion_Rule_Set_ID, Satisfactory_Academic_Progress_Rule_Set_ID, Student_Application_Configuration_Rule_Set_ID, Student_Payment_Plan_Rule_Set_ID, Student_Recruiting_Registration_Configuration_Rule_Set_ID, Student_Transfer_Grade_Mapping_Rule_Set_ID, Student_Unit_Type_Rule_Set_ID, Transcript_Configuration_Rule_Set_ID, Typical_Attendance_Pattern_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_PolicyReferenceEnumeration

part of: Completion_Honor_or_Award_PolicyObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

Academic_Unit_Policy_Rule_SetReferenceEnumeration

part of: Academic_Unit_Policy_Rule_SetObjectID
Base Type
string
top