Service Directory > v31.2 > Performance_Management > Get_Feedback_Badges
 

Operation: Get_Feedback_Badges

This operation allows the getting of Feedback Badges.


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

The request that gets all Feedback Badges.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
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_Feedback_Badges_Response

The Get Feedback Badges Response Element that contains the Feedback Badge Request References, Feedback Badge Request Criteria, Response Filter, Response Results, and Feedback Badge Response Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
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  Feedback__Badge_Response_Data  [0..1]  The response element for the Get Feedback Badges Web Service.   
top
 

Response_Filter

part of: Get_Feedback_Badges_Request, Get_Feedback_Badges_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_Feedback_Badges_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
 

Feedback__Badge_Response_Data

part of: Get_Feedback_Badges_Response
The response element for the Get Feedback Badges Web Service.
 
Parameter name Type/Value Cardinality Description Validations
Feedback_Badge  Feedback__Badge  [0..*]  The Feedback Badge Element that contains the Feedback Badge reference and Feedback Badge Data object.   
top
 

Feedback__Badge

part of: Feedback__Badge_Response_Data
The Feedback Badge that contains the Feedback Badge Reference and the Feedback Badge Data element.
 
Parameter name Type/Value Cardinality Description Validations
Feedback__Badge_Reference  Feedback_BadgeObject  [0..1]  The reference to the Feedback Badge class.   
Feedback_Badge_Data  Feedback_Badge_Data  [0..1]  The element which contains the Feedback Badge Name, icon, and inactive boolean for a Feedback Badge. 
Validation Description
Select a Workday-delivered icon associated with feedback badges.   
 
top
 

Feedback_BadgeObject

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

Feedback_BadgeObjectID

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

Feedback_Badge_Data

part of: Feedback__Badge
Element which contains the ID, Feedback Badge Name, Icon, and Inactive boolean for a Feedback Badge.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of a Feedback Badge.   
Feedback_Badge_Name  string  [0..1]  The Name for a Feedback Badge. 
Validation Description
You can't change the name of an inactive badge.   
 
Icon_Reference  IconObject  [0..1]  The Icon for a Feedback Badge.   
Inactive  boolean  [0..1]  The Inactive boolean for Feedback badge which determines whether or not a feedback badge is inactive.   
Validation Description
Select a Workday-delivered icon associated with feedback badges.   
top
 

IconObject

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

IconObjectID

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

Feedback_BadgeReferenceEnumeration

part of: Feedback_BadgeObjectID
Base Type
string
top
 

IconReferenceEnumeration

part of: IconObjectID
Base Type
string
top