Service Directory > v31.2 > Revenue_Management > Get_Award_Task_Type_Groups
 

Operation: Get_Award_Task_Type_Groups

This service operation will get Award Task Type Groups for the specified criteria. Award Task Type Group data includes Award Task Type Group Reference ID, Award Task Type Group Name, and Award Task Type Data. Award Task Type Data includes Award Task Type Reference ID, Award Task Type Name, and Award Task Type Is Inactive.


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

This element is the top-level request element for all Award Task Type Group "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Award_Task_Type_Groups_Request_References  [0..1]  This element content contains the Award Task Type Group reference element used to return the Award Task Type Group by unique identifier   
Request_Criteria [Choice]   Award_Task_Type_Group_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Award Task Type Group specific criteria needed to search for instances.   
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_Group  Award_Task_Type_Group_Response_Group  [0..1]  Element content containing Award Task Type Group Response Group element   
top
 

Response Element: Get_Award_Task_Type_Groups_Response

Element containing Award Task Type Group response elements including echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Award_Task_Type_Groups_Request_References  [0..1]  This element contains the specific instance set containing the requested Award Task Type Groups. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Award Task Type Group.   
Request_Criteria  Award_Task_Type_Group_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Award specific criteria needed to search for instances.   
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_Group  Award_Task_Type_Group_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Award Task Type Group response. If this element is not included then ALL of the Response Groups are included in the response.   
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  Award_Task_Type_Group_Response_Data  [0..1]  This element content contains the Award Task Type Group Response Data element.   
top
 

Award_Task_Type_Groups_Request_References

part of: Get_Award_Task_Type_Groups_Request, Get_Award_Task_Type_Groups_Response
This element contains the specific instance set containing the requested Award Task Type Groups. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Award Task Type Group.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Type_Group_Reference  Award_Task_Type_GroupObject  [0..*]  Award Task Type Groups requested for the Get operation.   
top
 

Award_Task_Type_GroupObject

part of: Award_Task_Type_Groups_Request_References, Award_Task_Type_Group, Award_Task_Type_Group_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  Award_Task_Type_GroupObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Award_Task_Type_GroupObjectID

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

Award_Task_Type_Group_Request_Criteria

part of: Get_Award_Task_Type_Groups_Request, Get_Award_Task_Type_Groups_Response
This element is the wrapper around a list of elements representing the Award specific criteria needed to search for instances.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Type_Group_Name  string  [0..1]  Name of the Award Task Type Group to return.   
top
 

Response_Filter

part of: Get_Award_Task_Type_Groups_Request, Get_Award_Task_Type_Groups_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
 

Award_Task_Type_Group_Response_Group

part of: Get_Award_Task_Type_Groups_Request, Get_Award_Task_Type_Groups_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Award Task Type Group response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Award Task Type Group Reference is to be included in the response   
top
 

Response_Results

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

Award_Task_Type_Group_Response_Data

part of: Get_Award_Task_Type_Groups_Response
Wrapper element containing Award Task Type Group Response Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Type_Group  Award_Task_Type_Group  [0..*]  Award Task Type Group element   
top
 

Award_Task_Type_Group

part of: Award_Task_Type_Group_Response_Data
Wrapper Element that includes all data for a single Award Task Type Group.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Type_Group_Reference  Award_Task_Type_GroupObject  [0..1]  Reference to a single Award Task Type Group for which data is being returned.   
Award_Task_Type_Group_Data  Award_Task_Type_Group_Data  [0..*]  This element contains all of the data to describe an Award Task Type Group.   
top
 

Award_Task_Type_Group_Data

part of: Award_Task_Type_Group
This element contains all of the data to describe an Award Task Type Group.
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Type_Group_Reference  Award_Task_Type_GroupObject  [0..1]  Reference to the Award Task Type Group for which data is being returned.   
Award_Task_Type_Group_Reference_ID  string  [0..1]  Award Task Type Group Reference ID. This is the Award Task Type Group Unique Identifier.   
Award_Task_Type_Group_Name  string  [1..1]  Award Task Type Group Name   
Award_Task_Type_Data  Award_Task_Type_Data  [0..*]  Award Task Type Data element   
top
 

Award_Task_Type_Data

part of: Award_Task_Type_Group_Data
Award Task Type Data for a single Award Task Type. An Award Task Type Group may have multiple
 
Parameter name Type/Value Cardinality Description Validations
Award_Task_Type_Reference  Award_Task_TypeObject  [0..1]  Reference to an existing Award Task Type.   
Award_Task_Type_Reference_ID  string  [0..1]  The Award Task Type Reference ID. This is the Award Task Type unique identifier.   
Award_Task_Type_Name  string  [1..1]  Award Task Type name.   
Award_Task_Type_For_Closeout_Task  boolean  [0..1]  A boolean flag indicating if the Award Task Type is for closeout or not.   
Award_Task_Type_Is_Inactive  boolean  [0..1]  A boolean flag indicating if the Award Task Type is inactive or not.   
top
 

Award_Task_TypeObject

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

Award_Task_TypeObjectID

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

Award_Task_Type_GroupReferenceEnumeration

part of: Award_Task_Type_GroupObjectID
Base Type
string
top
 

Award_Task_TypeReferenceEnumeration

part of: Award_Task_TypeObjectID
Base Type
string
top