Service Directory > v31.2 > Absence_Management > Get_Carryover_Override
 

Operation: Get_Carryover_Override

This operation gets Carryover Expiration/Limit Override for a ~Worker~ and Time Off Plan with the supplied information.


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

Get Carryover Override Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Carryover_Override_Request_References  [0..1]  Carryover Override Request References   
Request_Criteria [Choice]   Carryover_Override_Request_Criteria  [0..1]  Carryover Override 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_Group  Carryover_Override_Response_Group  [0..1]  Carryover Override Response Group   
top
 

Response Element: Get_Carryover_Override_Response

Get Carryover Override Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Carryover_Override_Request_References  [0..1]  Carryover Override Request References   
Request_Criteria  Carryover_Override_Request_Criteria  [0..1]  Carryover Override 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_Groups  Carryover_Override_Response_Group  [0..1]  Carryover Override Response Group   
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  Carryover_Override_Response_Data  [0..1]  Get Carryover Override Response   
top
 

Carryover_Override_Request_References

part of: Get_Carryover_Override_Request, Get_Carryover_Override_Response
Carryover Override Request References
 
Parameter name Type/Value Cardinality Description Validations
Carryover_Override_Reference  Carryover_Expiration_Limit_OverrideObject  [1..*]  Carryover Override Reference   
top
 

Carryover_Expiration_Limit_OverrideObject

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

Carryover_Expiration_Limit_OverrideObjectID

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

Carryover_Override_Request_Criteria

part of: Get_Carryover_Override_Request, Get_Carryover_Override_Response
Carryover Override Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
XMLNAME__Worker__Reference  WorkerObject  [0..1]  Worker Reference   
top
 

WorkerObject

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

WorkerObjectID

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

Carryover_Override_Response_Group

part of: Get_Carryover_Override_Request, Get_Carryover_Override_Response
Carryover Override Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
Include_Carryover_Override_Data  boolean  [0..1]  Include Carryover Override Data   
top
 

Response_Results

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

Carryover_Override_Response_Data

part of: Get_Carryover_Override_Response
Get Carryover Override Response
 
Parameter name Type/Value Cardinality Description Validations
Carryover_Override  Carryover_Override  [0..*]  Carryover Override Response Data   
top
 

Carryover_Override

part of: Carryover_Override_Response_Data
Carryover Override Response Data
 
Parameter name Type/Value Cardinality Description Validations
Carryover_Override_Reference  Carryover_Expiration_Limit_OverrideObject  [0..1]  Carryover Override   
Carryover_Override_Data  Carryover_Override_Data  [0..1]  Carryover Override 
Validation Description
Carryover Overrides cannot be loaded for a Time Off Plan for which Track Balance is False.   
Carryover Overrides cannot be loaded for a Time Off Plan for which Overrides Allowed is False.   
Remove matching inputs from carryover rules.   
Enter a carryover expiration override date that is on or after the carryover date.   
The Carryover Date input must match a carryover date in the absence plan configuration for a balance period.   
You can't edit carryover overrides for this worker as it affects a completed termination adjustment.   
Worker is not eligible for the Time Off Plan for the period that includes the carryover date.   
 
top
 

Carryover_Override_Data

part of: Carryover_Override
Carryover Override
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID   
XMLNAME__Worker__Reference  WorkerObject  [1..1]  Worker Reference   
Absence_Plan_Reference  Absence_Plan__All_Object  [1..1]  Absence Plan Reference   
Carryover_Date  date  [1..1]  Carryover Date   
Position_Reference  Position_ElementObject  [0..1]  Position Reference 
Validation Description
Position is not valid for this Worker as of the effective date. Worker: [worker] Position: [position] Date: [date]   
The field Position Reference is required and must have a value.   
Position Reference is not valid for the Time Off Plan Reference given.   
 
Carryover_Override_Amount  decimal (30, 6) >0   [0..1]  Carryover Limit Override Amount   
Carryover_Expiration_Date  date  [1..1]  Carryover Expiration Date   
Comments  string  [0..1]  Comments   
Validation Description
Carryover Overrides cannot be loaded for a Time Off Plan for which Track Balance is False.   
Carryover Overrides cannot be loaded for a Time Off Plan for which Overrides Allowed is False.   
Remove matching inputs from carryover rules.   
Enter a carryover expiration override date that is on or after the carryover date.   
The Carryover Date input must match a carryover date in the absence plan configuration for a balance period.   
You can't edit carryover overrides for this worker as it affects a completed termination adjustment.   
Worker is not eligible for the Time Off Plan for the period that includes the carryover date.   
top
 

Absence_Plan__All_Object

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

Absence_Plan__All_ObjectID

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

Position_ElementObject

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

Position_ElementObjectID

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

Carryover_Expiration_Limit_OverrideReferenceEnumeration

part of: Carryover_Expiration_Limit_OverrideObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Absence_Plan__All_ReferenceEnumeration

part of: Absence_Plan__All_ObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top