Service Directory > v31.2 > Revenue_Management > Get_Award_Schedules
 

Operation: Get_Award_Schedules

This service operation will get Award Schedules based on request criteria, or all Award Schedules if no request criteria is provided. Award Schedule Data includes Award Schedule Reference ID, Award Schedule Name, Award Posting Interval Group, and Award Year Data. Award Year Data contains year-by-year information for the award schedule, including Award Year Name, Award Year Numer, and Award Period Data. Award Period Data contains information for a single period within an award year, including Award Posting Interval Name, Award Period Start Date, and Award Period End Date.


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

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

Response Element: Get_Award_Schedules_Response

Element containing Award Schedule 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_Schedule_Request_References  [0..1]  Award Schedule Reference element contains the set of requested Award Schedules for which to return data.   
Request_Criteria  Award_Schedule_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Award Schedule 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_Schedule_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Award Schedule 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_Schedule_Response_Data  [0..1]  This element content contains the Response Data for the request.   
top
 

Award_Schedule_Request_References

part of: Get_Award_Schedules_Request, Get_Award_Schedules_Response
Award Schedule Reference element contains the set of requested Award Schedules for which to return data.
 
Parameter name Type/Value Cardinality Description Validations
Award_Schedule_Reference  Award_ScheduleObject  [1..*]  Reference Award Schedule for which data will be returned   
top
 

Award_ScheduleObject

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

Award_ScheduleObjectID

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

part of: Get_Award_Schedules_Request, Get_Award_Schedules_Response
This element is the wrapper around a list of elements representing the Award Schedule specific criteria needed to search for instances.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Award_Schedules_Request, Get_Award_Schedules_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_Schedule_Response_Group

part of: Get_Award_Schedules_Request, Get_Award_Schedules_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Award Schedule 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 Schedule Reference data is to be included in the response   
top
 

Response_Results

part of: Get_Award_Schedules_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_Schedule_Response_Data

part of: Get_Award_Schedules_Response
Wrapper element containing Awarde Schedule Response Data for requested references or criteria and for the response group
 
Parameter name Type/Value Cardinality Description Validations
Award_Schedule  Award_Schedule  [0..*]  Element containing Award Schedule data for the request   
top
 

Award_Schedule

part of: Award_Schedule_Response_Data
Wrapper Element containing an Award Schedule Reference and all data for the single Award Schedule
 
Parameter name Type/Value Cardinality Description Validations
Award_Schedule_Reference  Award_ScheduleObject  [0..1]  The Award Schedule for which data is returned.   
Award_Schedule_Data  Award_Schedule_Data  [0..*]  Contains all References and Attributes to represent a complete Award Schedule. 
Validation Description
Select only one Contract Start Date and one Contract End Date.   
Enter a Contract Start Date that is before the Contract End Date.   
 
top
 

Award_Schedule_Data

part of: Award_Schedule
Contains all References and Attributes to represent a complete Award Schedule.
 
Parameter name Type/Value Cardinality Description Validations
Award_Schedule_Reference_ID  string  [0..1]  Award Schedule Reference ID. This is the Award Schedule Unique Identifier.   
Award_Schedule_Name  string  [1..1]  Award Schedule Name   
Award_Posting_Interval_Group_Reference  Award_Posting_Interval_GroupObject  [1..*]  A reference to the Award Posting Interval Group for the Award Schedule. The Award Posting Interval Group indicates the interval information (periods per year) for the Award Schedule.   
Award_Period_Data  Award_Year_Data  [0..*]  Encapsulating element for information describing an Award Period 
Validation Description
Enter a Period Name that isn't already in use.   
Enter an Award Period Number that isn't already in use.   
Award Period must contain all the Posting Interval Names from the Award Posting Interval Group.   
 
Validation Description
Select only one Contract Start Date and one Contract End Date.   
Enter a Contract Start Date that is before the Contract End Date.   
top
 

Award_Posting_Interval_GroupObject

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

Award_Posting_Interval_GroupObjectID

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

part of: Award_Schedule_Data
Award Period Data contains all information describing a single period of the Award Schedule.
 
Parameter name Type/Value Cardinality Description Validations
Award_Period_Reference_ID  string  [0..1]  Award Period Reference ID. This is the Award Period unique identifier.   
Award_Period_Name  string  [1..1]  Award Period Name   
Award_Period_Number  decimal (4, 0) >0   [1..1]  Award Period Number   
Award_Interval_Data  Award_Period_Data  [0..*]  Award Interval Data Element 
Validation Description
Enter a Start Date that is before the end date.   
Award Intervals cannot overlap.   
There cannot be any gaps between Award Intervals.   
 
Is_Award_Contract_Start_Date  boolean  [0..1]  The Award Period End Date is Award Contract End Date.   
Is_Award_Contract_End_Date  boolean  [0..1]  The Award Period Start Date is Award Contract Start Date.   
Validation Description
Enter a Period Name that isn't already in use.   
Enter an Award Period Number that isn't already in use.   
Award Period must contain all the Posting Interval Names from the Award Posting Interval Group.   
top
 

Award_Period_Data

part of: Award_Year_Data
Award Period Data contains all information describing a single Period within the Award Year
 
Parameter name Type/Value Cardinality Description Validations
Award_Posting_Interval_Reference  Award_Posting_IntervalObject  [0..1]  The Award Positing Interval for the Award Period   
Award_Posting_Interval_ID  string  [0..1]  The Award Positing Interval Reference Id for the Award Period   
Award_Posting_Interval_Name_Reference  Award_Posting_Interval_NameObject  [1..1]  A Reference to the Award Posting Interval Name for the Award Period. Award Posting Interval Names are defined by the Award Posting Interval Group for the Award Schedule. 
Validation Description
Enter a Posting Interval that is after the previous posting interval. The interval [current] isn't after the interval [previous].   
 
Award_Interval_Start_Date  date  [0..1]  The Start Date of Award Interval   
Award_Interval_End_Date  date  [0..1]  The End Date of Award Interval   
Validation Description
Enter a Start Date that is before the end date.   
Award Intervals cannot overlap.   
There cannot be any gaps between Award Intervals.   
top
 

Award_Posting_IntervalObject

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

Award_Posting_IntervalObjectID

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

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

Award_Posting_Interval_NameObjectID

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

part of: Award_ScheduleObjectID
Base Type
string
top
 

Award_Posting_Interval_GroupReferenceEnumeration

part of: Award_Posting_Interval_GroupObjectID
Base Type
string
top
 

Award_Posting_IntervalReferenceEnumeration

part of: Award_Posting_IntervalObjectID
Base Type
string
top
 

Award_Posting_Interval_NameReferenceEnumeration

part of: Award_Posting_Interval_NameObjectID
Base Type
string
top