Service Directory > v32.1 > Absence_Management > Enter_Time_Off
 

Operation: Enter_Time_Off

This operation will add new time off entries. It uses the Request Time Off business process event.


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

The purpose of this spreadsheet is to provide a facility to upload data from Microsoft Excel into your Workday system. By performing this upload process, the customer acknowledges that they have already performed the required business process tasks and approvals to confirm the worker's new data values. This spreadsheet contains worksheets for "Enter Time Off"; both the main process and available related processes. Fill out these worksheets with the data to match your business processes. It is understood that different supervisory organizations may have a different business processes and therefore not every worker will necessarily go through all the optional related processes.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Enter_Time_Off_Data  Enter_Time_Off_Data  [1..1]  Request 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.   
 
top
 

Response Element: Time_Off_Event_Response

Root Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Time_Off_Event_Reference  Unique_IdentifierObject  [0..1]  A reference to an existing Time Off Event in the system   
Time_Off_Entry_References  Time_Off_Entry_References  [0..*]  A list of references to Time Off Entries in the system   
top
 

Business_Process_Parameters

part of: Enter_Time_Off_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

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

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
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Time_Off_Event_Response
Time Off Entry References
 
Parameter name Type/Value Cardinality Description Validations
Time_Off_Entry_Reference  Time_Off_EntryObject  [0..*]  A reference to a Time Off Entry   
top
 

Time_Off_EntryObject

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

Time_Off_EntryObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Time_Off_EntryReferenceEnumeration

part of: Time_Off_EntryObjectID
Base Type
string
top