Service Directory > v31.2 > Absence_Management > Get_Absence_Inputs
 

Operation: Get_Absence_Inputs

This operation will get information for Accrual or Time Off Adjustments/Overrides for employees and/or batch id's specified in the request or information for all if no criteria is specified in the request.


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

Get Absence Inputs Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Absence_Input_Request_References  [0..1]  Absence Input Request References   
Request_Criteria [Choice]   Absence_Input_Request_Criteria  [0..1]  Absence Input Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Absence_Input_Response_Group  [0..1]  Absence Input Response Group   
top
 

Response Element: Get_Absence_Inputs_Response

Get Absence Inputs Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Absence_Input_Request_References  [0..1]  Absence Input Request References   
Request_Criteria  Absence_Input_Request_Criteria  [0..1]  Absence Input Request Criteria   
Response_Filter  Response_Filter  [0..1]  The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Absence_Input_Response_Group  [0..1]  Absence Input 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  Absence_Input_Response_Data  [0..1]  Absence Input Response Data   
top
 

Absence_Input_Request_References

part of: Get_Absence_Inputs_Request, Get_Absence_Inputs_Response
Absence Input Request References
 
Parameter name Type/Value Cardinality Description Validations
Absence_Input_Reference  Absence_InputObject  [1..*]  Absence Input Request References   
top
 

Absence_InputObject

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

Absence_InputObjectID

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

Absence_Input_Request_Criteria

part of: Get_Absence_Inputs_Request, Get_Absence_Inputs_Response
Absence Input Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [0..1]  Payee Reference   
Batch_Reference  Application_BatchObject  [0..1]  Batch Reference   
top
 

WorkerObject

part of: Absence_Input_Data, Absence_Input_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
 

Application_BatchObject

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

Application_BatchObjectID

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

Absence_Input_Response_Group

part of: Get_Absence_Inputs_Request, Get_Absence_Inputs_Response
Absence Input Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Ad Hoc Billable Transaction Reference data is to be included in the response.   
Include_Absence_Input_Data  boolean  [0..1]  Include Absence Input Data   
top
 

Response_Results

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

Absence_Input_Response_Data

part of: Get_Absence_Inputs_Response
Absence Input Response Data
 
Parameter name Type/Value Cardinality Description Validations
Absence_Input  Absence_Input  [0..*]  Absence Input   
top
 

Absence_Input

part of: Absence_Input_Response_Data
Absence Input
 
Parameter name Type/Value Cardinality Description Validations
Absence_Input_Reference  Absence_InputObject  [0..1]  Absence Input Reference   
Absence_Input_Data  Absence_Input_Data  [0..1]  Absence Input Data 
Validation Description
End Date is invalid. A period ending on the End Date is not found for the Accrual or Time Off being processed.  End Date is invalid. A period ending on the End Date is not found for the Accrual or Time Off being processed. 
Start Date is invalid. A period beginning on the Start Date is not found for the Accrual or Time Off being processed.  Start Date is invalid. A period beginning on the Start Date is not found for the Accrual or Time Off being processed. 
The Accrual or Time Off being processed does not allow adjustments or overrides.  The Accrual or Time Off being processed does not allow adjustments or overrides. 
Start Period must equal End Period when Adjustment is true.  Start Period must equal End Period when Adjustment is true. 
Reference Date must be within the Start Period for Time Off.  Reference Date must be within the Start Period for Time Off. 
An override is not allowed for Time Off. Change the Adjustment flag to true.  An override is not allowed for Time Off. Change the Adjustment flag to true. 
Batch ID is already associated with other types of Application Batches.  Batch ID is already associated with other types of Application Batches. 
End Date is required when Adjustment is true.  End Date is required when Adjustment is true. 
You cannot make changes to this input as it affects a completed termination adjustment.  You cannot make changes to this input as it affects a completed termination adjustment. 
Overrides cannot be setup for overlapping periods. Only adjustments can be setup for overlapping periods.  Overrides cannot be setup for overlapping periods. Only adjustments can be setup for overlapping periods. 
Overrides cannot be setup for overlapping periods. Only adjustments can be setup for overlapping periods.  Overrides cannot be setup for overlapping periods. Only adjustments can be setup for overlapping periods. 
End Date must be equal to or greater than the Start Date.  End Date must be equal to or greater than the Start Date. 
End Date is blank but later periods associated with this snapshot are ineligible for overrides. Select the [Latest End Period] period or an earlier period.   
 
top
 

Absence_Input_Data

part of: Absence_Input
Absence Input Data
 
Parameter name Type/Value Cardinality Description Validations
Absence_Input_ID  string  [0..1]  Absence Input ID (Used as a Lookup ID to perform an update. If not provided, the web service will add a new instance).   
Batch_ID  string  [0..1]  Batch ID is the unique identifier.   
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Position_Reference  Position_ElementObject  [0..1]  Position Reference 
Validation Description
The field Position Reference is required for the selected Absence Component.   
Position Reference is not valid for the Absence Component Reference given.   
Position is not valid for this Worker as of either the start date or end date of the Absence Input. Worker: [worker] Position: [position] Start Date: [start date] End Date: [end date]   
 
Absence_Component_Reference  Absence_ComponentObject  [1..1]  Absence Component Reference   
Start_Date  date  [1..1]  Start Date of Start Period   
End_Date  date  [0..1]  End Date of End Period   
Reference_Date  date  [1..1]  The Reference Date is used to determine the effective date to retrieve the snapshot for the absence component for the input. Reference Date is required for Time Off and Accrual.   
Hours  decimal (18, 6)   [0..1]  Absence Hours   
Adjustment  boolean  [0..1]  Adjustment (1=True, 0=False)   
Comment  string  [0..1]  Comment   
Validation Description
End Date is invalid. A period ending on the End Date is not found for the Accrual or Time Off being processed.  End Date is invalid. A period ending on the End Date is not found for the Accrual or Time Off being processed. 
Start Date is invalid. A period beginning on the Start Date is not found for the Accrual or Time Off being processed.  Start Date is invalid. A period beginning on the Start Date is not found for the Accrual or Time Off being processed. 
The Accrual or Time Off being processed does not allow adjustments or overrides.  The Accrual or Time Off being processed does not allow adjustments or overrides. 
Start Period must equal End Period when Adjustment is true.  Start Period must equal End Period when Adjustment is true. 
Reference Date must be within the Start Period for Time Off.  Reference Date must be within the Start Period for Time Off. 
An override is not allowed for Time Off. Change the Adjustment flag to true.  An override is not allowed for Time Off. Change the Adjustment flag to true. 
Batch ID is already associated with other types of Application Batches.  Batch ID is already associated with other types of Application Batches. 
End Date is required when Adjustment is true.  End Date is required when Adjustment is true. 
You cannot make changes to this input as it affects a completed termination adjustment.  You cannot make changes to this input as it affects a completed termination adjustment. 
Overrides cannot be setup for overlapping periods. Only adjustments can be setup for overlapping periods.  Overrides cannot be setup for overlapping periods. Only adjustments can be setup for overlapping periods. 
Overrides cannot be setup for overlapping periods. Only adjustments can be setup for overlapping periods.  Overrides cannot be setup for overlapping periods. Only adjustments can be setup for overlapping periods. 
End Date must be equal to or greater than the Start Date.  End Date must be equal to or greater than the Start Date. 
End Date is blank but later periods associated with this snapshot are ineligible for overrides. Select the [Latest End Period] period or an earlier period.   
top
 

Position_ElementObject

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

Absence_ComponentObject

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

Absence_ComponentObjectID

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

Absence_InputReferenceEnumeration

part of: Absence_InputObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Application_BatchReferenceEnumeration

part of: Application_BatchObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Absence_ComponentReferenceEnumeration

part of: Absence_ComponentObjectID
Base Type
string
top