Service Directory > v31.2 > Revenue_Management > Get_Award_Groups
 

Operation: Get_Award_Groups

Test Run Award Group Get Task


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

Request element for Award Group
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Award_Group_Request_References  [0..1]  Element containing request references for Get Award Group   
Request_Criteria [Choice]   Award_Group_Request_Criteria  [0..1]  Element containing request criteria for Get Award Group   
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_Award_Groups_Response

Responds with the Award Group requested
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Award_Group_Request_References  [0..1]  Contains the specific instance set containing the requested Award Group.   
Request_Criteria  Award_Group_Request_Criteria  [0..1]  Award Group Request Criteria   
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  Award_Group_Response_Data  [0..1]  Award Group Response Data   
top
 

Award_Group_Request_References

part of: Get_Award_Groups_Request, Get_Award_Groups_Response
Element containing request references for Get Award Group
 
Parameter name Type/Value Cardinality Description Validations
Award_Group_Reference  Award_GroupObject  [1..*]  Name of an existing Award Group   
top
 

Award_GroupObject

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

Award_GroupObjectID

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

part of: Get_Award_Groups_Request, Get_Award_Groups_Response
Element containing request criteria for Get Award Group
 
Parameter name Type/Value Cardinality Description Validations
Award_Group_Name  string  [0..1]  Name of an existing Award Group   
Award_Reference  Award_ContractObject  [0..*]  Reference to an existing Award   
Inactive  boolean  [0..1]  Inactive status of an existing Award Group   
Active  boolean  [0..1]  Active status of an existing Award   
top
 

Award_ContractObject

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

Award_ContractObjectID

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

Response_Filter

part of: Get_Award_Groups_Request, Get_Award_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
 

Response_Results

part of: Get_Award_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_Group_Response_Data

part of: Get_Award_Groups_Response
Wrapper element containing Award Group Response Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Award_Group  Award_Group  [0..*]  Wrapper Element that includes all data for a single Award Group.   
top
 

Award_Group

part of: Award_Group_Response_Data
Wrapper Element that includes all data for a single Award Group.
 
Parameter name Type/Value Cardinality Description Validations
Award_Group_Reference  Award_GroupObject  [0..1]  Reference to a single Award Group for which data is being returned.   
Award_Group_Data  Award_Group_Data  [0..1]  This element contains all of the data to describe an Award Group in Workday.   
top
 

Award_Group_Data

part of: Award_Group
This element contains all of the data to describe an Award Group in Workday.
 
Parameter name Type/Value Cardinality Description Validations
Award_Group_Reference_ID  string  [0..1]  Award Group Reference ID. This is the Award Group Unique Identifier.   
Name  string  [0..1]  Name of Award Group 
Validation Description
The Award Group Name must be unique   
 
Description  RichText  [0..1]  Description of Award Group   
Award_Contracts_Reference  Award_ContractObject  [0..*]  Award Contracts belonging to this Award Group   
Inactive  boolean  [0..1]  Set to True means this Award Group is no longer active.   
top
 

Award_GroupReferenceEnumeration

part of: Award_GroupObjectID
Base Type
string
top
 

Award_ContractReferenceEnumeration

part of: Award_ContractObjectID
Base Type
string
top
 

RichText

part of: Award_Group_Data
Base Type
string
top