Service Directory > v32.1 > Absence_Management > Import_Time_Off_Request_Event_Batch
 

Operation: Import_Time_Off_Request_Event_Batch

Imports a batch of Time Off Request Events that are processed in a background process which persists only those that pass validation.


@ - 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: Import_Time_Off_Request_Event_Batch_Request

Wrapper element which contains collection of Enter Time Off Data elements needed for a Time Off Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Enter_Time_Off_Data  Enter_Time_Off_Data  [0..*]  Enter Time Off Data element contains the data needed for a Time Off Request. 
Validation Description
Turn Off Run Time Calculations with Time Off Approval can not be true if the Run Time Calculations for Time Off Approval Tenant Setup Option is False   
[unpaid critical time off error message]   
[max warning time off error message]   
Multiple time off requests for the same position and/or date are not allowed.   
 
Validation Description
To allow Time Off Requests to process correctly all Time Off Requests for each individual Worker must be on the same Line Key.   
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Enter_Time_Off_Data

part of: Import_Time_Off_Request_Event_Batch_Request
Contains Request Time Off data
 
Parameter name Type/Value Cardinality Description Validations
Turn_Off_Run_Time_Calculations_with_Time_Off_Approval  boolean  [0..1]  Turn on this flag if you want to ignore the Tenant Setup for Run Time Calculations with Time Off Approval for the Time Off Request   
Run_Time_Off_Validations  boolean  [0..1]  Turn on this flag if you want to validate Time Off Entries for this Time Off Request. If this flag is turned on and any Time Off Entries fail validation for a Time Off Request, the entire Time Off Request will be rejected.   
Worker_Reference  WorkerObject  [1..1]  Reference to an existing Worker   
Enter_Time_Off_Entry_Data  Enter_Time_Off_Entry_Data  [1..*]  Element containing the Time Off Data for an employee 
Validation Description
[min warning time off error message]   
[inc warning time off error message]   
You must specify only one of Time Off Type, Time Off, or Absence Table.  You must specify only one of Time Off Type, Time Off, or Absence Table. 
The dates selected aren't allowed for [type]. Change the dates or select a different Time Off Type.   
You do not have a sufficient balance/or are not eligible to satisfy the request for [type] as of [date].   
The Time Off belongs to an Absence Table. Update the request to use the Absence Table, or a different Time Off that does not belong to an Absence Table.  The Time Off belongs to an Absence Table. Update the request to use the Absence Table, or a different Time Off that does not belong to an Absence Table. 
Time Off Reason must be provided for a Time Off which has Reason Required defined.  Time Off Reason must be provided for a Time Off which has Reason Required defined. 
Time Off Reason must be provided for an Absence Table which has Reason Required defined.  Time Off Reason must be provided for an Absence Table which has Reason Required defined. 
Time Off Reason provided is not valid for Absence Table provided.  Time Off Reason provided is not valid for Absence Table provided. 
Time Off Reason provided is not valid for Time Off provided.  Time Off Reason provided is not valid for Time Off provided. 
 
Validation Description
Turn Off Run Time Calculations with Time Off Approval can not be true if the Run Time Calculations for Time Off Approval Tenant Setup Option is False   
[unpaid critical time off error message]   
[max warning time off error message]   
Multiple time off requests for the same position and/or date are not allowed.   
top
 

WorkerObject

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

Enter_Time_Off_Entry_Data

part of: Enter_Time_Off_Data
Data for Employee Paid TIme Off
 
Parameter name Type/Value Cardinality Description Validations
Time_Off_Entry_ID  string  [0..1]  An "ID" value for the Time Off Entry record that is to be added. This "ID" can be used to lookup Time Off Entry record for adjustments. 
Validation Description
Duplicate ID values are not allowed.   
 
Date  date  [1..1]  The date (YYYY-MM-DD) value for the time off taken.   
Requested  decimal (9, 6)   [1..1]  The requested units for the time off taken. For example, if the Time Off is being tracked in hours, enter the number of requested hours. 
Validation Description
The number of units requested must be greater than zero. If you want to change approved time off, use the Adjust Time Off operation or go to Correct Time Off via the User Interface.   
 
Time_Off_Type_Reference  Time_Off_TypeObject  [0..1]  Reference to an existing Time Off Type 
Validation Description
Worker is not eligible for this Time Off on this date.   
Time Off is configured for Enter through Time Tracking Only.  Time Off is configured for Enter through Time Tracking Only. 
 
Time_Off_Reference  Time_OffObject  [0..1]  Reference to an existing Time Off 
Validation Description
Absence Tables cannot be used on Web Service tasks.   
Worker is not eligible for this Time Off on this date.   
Time Off is configured for Enter through Time Tracking Only.  Time Off is configured for Enter through Time Tracking Only. 
 
Absence_Table_Reference  Absence_TableObject  [0..1]  Element Content holds optional reference to Absence Table for Time Off Request.   
Position_Reference  Position_ElementObject  [0..1]  Position Reference for the given Employee 
Validation Description
The field Position Reference is required and must have a value.   
The Position field is not valid for this Time Off Plan.   
Position is not valid for this Worker as of the effective date. Worker: [worker] Position: [position] Date: [date]   
 
Time_Off_Reason_Reference  Time_Off_ReasonObject  [0..1]  The reason for the time off request.   
Comment  string  [0..1]  Comment about the Time Off Entry.   
Validation Description
[min warning time off error message]   
[inc warning time off error message]   
You must specify only one of Time Off Type, Time Off, or Absence Table.  You must specify only one of Time Off Type, Time Off, or Absence Table. 
The dates selected aren't allowed for [type]. Change the dates or select a different Time Off Type.   
You do not have a sufficient balance/or are not eligible to satisfy the request for [type] as of [date].   
The Time Off belongs to an Absence Table. Update the request to use the Absence Table, or a different Time Off that does not belong to an Absence Table.  The Time Off belongs to an Absence Table. Update the request to use the Absence Table, or a different Time Off that does not belong to an Absence Table. 
Time Off Reason must be provided for a Time Off which has Reason Required defined.  Time Off Reason must be provided for a Time Off which has Reason Required defined. 
Time Off Reason must be provided for an Absence Table which has Reason Required defined.  Time Off Reason must be provided for an Absence Table which has Reason Required defined. 
Time Off Reason provided is not valid for Absence Table provided.  Time Off Reason provided is not valid for Absence Table provided. 
Time Off Reason provided is not valid for Time Off provided.  Time Off Reason provided is not valid for Time Off provided. 
top
 

Time_Off_TypeObject

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

Time_Off_TypeObjectID

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

Time_OffObject

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

Time_OffObjectID

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

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

Absence_TableObjectID

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

Time_Off_ReasonObject

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

Time_Off_ReasonObjectID

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

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Time_Off_TypeReferenceEnumeration

part of: Time_Off_TypeObjectID
Base Type
string
top
 

Time_OffReferenceEnumeration

part of: Time_OffObjectID
Base Type
string
top
 

Absence_TableReferenceEnumeration

part of: Absence_TableObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Time_Off_ReasonReferenceEnumeration

part of: Time_Off_ReasonObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top