Service Directory > v31.2 > Revenue_Management > Get_Award_Credit_Definitions
 

Operation: Get_Award_Credit_Definitions

This web service operation gets award credit definitions based on request criteria or gets all award credit definitions if no request criteria is provided. Award credit definition data includes Award Credit Definition Reference, Award Credit Definition ID, Award Credit Definition Name, Award Credit Definition Description, Required Worktag Type Reference, Optional Worktag Type Reference, Managing Company Reference, and 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_Credit_Definitions_Request

This element is the top-level request element for all award credit definitions "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Award_Credit_Definition_Request_References  [0..1]  This element content contains the award credit definition reference element used to return award credit definition by Reference ID.   
Request_Criteria [Choice]   Award_Credit_Definition_Request_Criteria  [0..1]  Criteria for retrieving award credit definition.   
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_Credit_Definition_Response_Group  [0..1]  Element containing Include Reference boolean indicator.   
top
 

Response Element: Get_Award_Credit_Definitions_Response

Element containing award credit definition response elements including echoed request data and request result.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Award_Credit_Definition_Request_References  [0..1]  This element content contains the award credit definition reference element used to return award credit definition by Reference ID.   
Request_Criteria  Award_Credit_Definition_Request_Criteria  [0..1]  Criteria for retrieving award credit definition.   
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_Credit_Definition_Response_Group  [0..1]  Element containing Include Reference boolean indicator.   
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_Credit_Definition_Response_Data  [0..1]  Wrapper element containing award credit definition response data for requested references or criteria.   
top
 

Award_Credit_Definition_Request_References

part of: Get_Award_Credit_Definitions_Request, Get_Award_Credit_Definitions_Response
This element content contains the award credit definition reference element used to return award credit definition by Reference ID.
 
Parameter name Type/Value Cardinality Description Validations
Award_Credit_Definition_Reference  Award_Credit_DefinitionObject  [1..*]  Award credit definition references that are used to return award credit definitions.   
top
 

Award_Credit_DefinitionObject

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

Award_Credit_DefinitionObjectID

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

part of: Get_Award_Credit_Definitions_Request, Get_Award_Credit_Definitions_Response
Criteria for retrieving award credit definition.
 
Parameter name Type/Value Cardinality Description Validations
Award_Credit_Definition_Name  string  [0..1]  Name of the award credit definition to return   
top
 

Response_Filter

part of: Get_Award_Credit_Definitions_Request, Get_Award_Credit_Definitions_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_Credit_Definition_Response_Group

part of: Get_Award_Credit_Definitions_Request, Get_Award_Credit_Definitions_Response
Element containing Include Reference boolean indicator.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  whether or not to include reference   
top
 

Response_Results

part of: Get_Award_Credit_Definitions_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_Credit_Definition_Response_Data

part of: Get_Award_Credit_Definitions_Response
Wrapper element containing award credit definition response data for requested references or criteria.
 
Parameter name Type/Value Cardinality Description Validations
Award_Credit_Definition  Award_Credit_Definition  [0..*]  Wrapper element containing an award credit definition reference and all data for the single award credit definition.   
top
 

Award_Credit_Definition

part of: Award_Credit_Definition_Response_Data
Wrapper element containing an award credit definition reference and all data for the single award credit definition.
 
Parameter name Type/Value Cardinality Description Validations
Award_Credit_Definition_Reference  Award_Credit_DefinitionObject  [0..1]  The award credit defintion for which data is returned.   
Award_Credit_Definition_Data  Award_Credit_Definition_Data  [0..*]  Contains all References and Attributes to represent a complete award credit definition.   
top
 

Award_Credit_Definition_Data

part of: Award_Credit_Definition
Enter the award credit definition data.
 
Parameter name Type/Value Cardinality Description Validations
Award_Credit_Definition_ID  string  [0..1]  Enter the award credit definition ID.   
Award_Credit_Definition_Name  string  [0..1]  Enter the award credit definition name. 
Validation Description
Enter an award credit definition name that does not already exist.  Enter an award credit definition name that does not already exist. 
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Award_Credit_Definition_Description  string  [0..1]  Enter the award credit definition description. 
Validation Description
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Required_Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..*]  Enter the required worktag types for the award credit definition. 
Validation Description
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Optional_Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..*]  Enter the optional worktag types for the award credit definition. 
Validation Description
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Managing_Company_Reference  CompanyObject  [0..*]  Enter the managing company for the award credit definition. 
Validation Description
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Inactive  boolean  [0..1]  True if the award credit definition is inactive.   
top
 

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

CompanyObject

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

CompanyObjectID

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

part of: Award_Credit_DefinitionObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top