Service Directory > v31.2 > Revenue_Management > Get_Award_Lifecycle_Statuses
 

Operation: Get_Award_Lifecycle_Statuses

This service operation will get Award Lifecycle Statuses based on request criteria, or all Award Lifecycle Statuses if no request criteria is provided. Award Lifecycle Status Data includes Award Lifecycle Status Reference ID, Award Lifecycle Status Name, Award Lifecycle Status Valid at Award, Award Lifecycle Status Valid at Award Line, Award Lifecycle Status Default at Award, Award Lifecycle Status Default at Award Line, and Award Lifecycle Status 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_Lifecycle_Statuses_Request

This element is the top-level request element for all Award Lifecycle Status "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Award_Lifecycle_Status_Request_References  [0..1]  This element content contains the Award Lifecycle Status reference element used to return Award Lifecycle Status by Reference ID.   
Response_Filter  Response_Filter  [0..1]  Element content containing Award Lifecycle Status Response Filter element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Award_Lifecycle_Statuses_Response

Element containing Award Lifecycle Status 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_Lifecycle_Status_Request_References  [0..*]  Award Lifecycle Status Request References element contains the set of requested Award Lifecycle Statuses for which to return data.   
Response_Filter  Response_Filter  [0..*]  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..*]  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_Lifecycle_Status_Response_Data  [0..*]  Wrapper element containing Award Lifecycle Status Response Data for requested references or criteria   
top
 

Award_Lifecycle_Status_Request_References

part of: Get_Award_Lifecycle_Statuses_Request, Get_Award_Lifecycle_Statuses_Response
Award Lifecycle Status Request References element contains the set of requested Award Lifecycle Statuses for which to return data.
 
Parameter name Type/Value Cardinality Description Validations
Award_Lifecycle_Status_Request_Reference  Award_Lifecycle_StatusObject  [1..*]  Reference Award Lifecycle Status for which data will be returned   
top
 

Award_Lifecycle_StatusObject

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

Award_Lifecycle_StatusObjectID

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

part of: Get_Award_Lifecycle_Statuses_Response
Wrapper element containing Award Lifecycle Status Response Data for requested references or criteria
 
Parameter name Type/Value Cardinality Description Validations
Award_Lifecycle_Status  Award_Lifecycle_Status  [0..*]  The response for a request for Award Lifecycle Status data.   
top
 

Award_Lifecycle_Status

part of: Award_Lifecycle_Status_Response_Data
Wrapper Element containing an Award Lifecycle Status Reference and all data for the single Award Lifecycle Status.
 
Parameter name Type/Value Cardinality Description Validations
Award_Lifecycle_Status_Reference  Award_Lifecycle_StatusObject  [0..1]  The Award Lifecycle Status for which data is returned.   
Award_Lifecycle_Status_Data  Award_Lifecycle_Status_Data  [0..*]  Contains all References and Attributes to represent a complete Award Lifecycle Status.   
top
 

Award_Lifecycle_Status_Data

part of: Award_Lifecycle_Status
Contains all References and Attributes to represent a complete Award Lifecycle Status.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Award Lifecycle Status Reference ID. This is the Award Lifecycle Status Unique Identifier.   
Award_Lifecycle_Status_Name  string  [1..1]  The Award Lifecycle Status Name. 
Validation Description
Enter an Award Lifecycle Status that isn't already in use.  Enter an Award Lifecycle Status that isn't already in use. 
You cannot change the Award Lifecycle Status because it's already in use.  You cannot change the Award Lifecycle Status because it's already in use. 
 
Award_Lifecycle_Status_Valid_for_Award  boolean  [0..1]  The Award Lifecycle Status Valid for Header flag. 
Validation Description
You cannot change the Valid for Award selection because the Award Lifecycle Status is in use.  You cannot change the Valid for Award selection because the Award Lifecycle Status is in use. 
 
Award_Lifecycle_Status_Valid_for_Award_Line  boolean  [0..1]  The Award Lifecycle Status Valid for Award Line flag. 
Validation Description
You cannot change the Valid for Award line selection because the Award Lifecycle Status is in use.  You cannot change the Valid for Award line selection because the Award Lifecycle Status is in use. 
 
Award_Lifecycle_Status_Default_for_Award  boolean  [0..1]  The Award Lifecycle Status Default for Award flag. 
Validation Description
Select 1 Award Lifecycle Status to use as the default on new awards.  Select 1 Award Lifecycle Status to use as the default on new awards. 
You cannot set an inactive Award Lifecycle Status as the default for an award.  You cannot set an inactive Award Lifecycle Status as the default for an award. 
You cannot set an Award Lifecycle Status that is invalid for the award as the default.  You cannot set an Award Lifecycle Status that is invalid for the award as the default. 
 
Award_Lifecycle_Status_Default_for_Award_Line  boolean  [0..1]  The Award Lifecycle Status Default for Award Line flag. 
Validation Description
Select 1 Award Lifecycle Status to use as the default on new award lines.  Select 1 Award Lifecycle Status to use as the default on new award lines. 
You cannot set an inactive Award Line Lifecycle Status as the default for an award line.  You cannot set an inactive Award Line Lifecycle Status as the default for an award line. 
You cannot set an Award Line Lifecycle Status that is invalid for the award line as the default.  You cannot set an Award Line Lifecycle Status that is invalid for the award line as the default. 
 
Award_Lifecycle_Status_Inactive  boolean  [0..1]  The Award Lifecycle Status Inactive flag.   
top
 

Award_Lifecycle_StatusReferenceEnumeration

part of: Award_Lifecycle_StatusObjectID
Base Type
string
top