Service Directory > v32.1 > Staffing > Put_Edit_Notice_Periods_Event
 

Operation: Put_Edit_Notice_Periods_Event

Adds or updates notice period details. Uses the Edit Notice Periods business process.


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

Request element for Put Edit Notice Periods Event.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Business Process Parameters   
Put_Edit_Notice_Periods_Event_Data  Put_Edit_Notice_Periods_Event_Data  [1..1]  Put Edit Notice Periods Event Data 
Validation Description
Employee data supplied but shouldn't be.   
Employer data supplied but shouldn't be.   
Employee data not supplied but should be.   
Employer data not supplied but should be.   
You already specified a notice period for [date]. Select a different Effective Date or change the notice period that is effective from [date] for this employee.   
The Effective Date can't be before the Hire Date or after the Termination Date. Select a different Effective Date.   
On [date], this employee's primary job is not in a location with active notice period localization settings.   
 
top
 

Response Element: Put_Edit_Notice_Periods_Event_Response

Response element for Put Edit Notice Periods Event.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Edit_Notice_Periods_Event_Reference  Unique_IdentifierObject  [0..1]  Edit Notice Periods Event Reference   
top
 

Business_Process_Parameters

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

Put_Edit_Notice_Periods_Event_Data

part of: Put_Edit_Notice_Periods_Event_Request
Contains data for the Edit Notice Periods event.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [1..1]  Employee Reference   
Effective_Date  date  [1..1]  Effective Date   
Employer_Notice_Period_Data  Employer_Notice_Period_Data  [0..1]  Employer Notice Period Data   
Employee_Notice_Period_Data  Employee_Notice_Period_Data  [0..1]  Employee notice period data.   
Validation Description
Employee data supplied but shouldn't be.   
Employer data supplied but shouldn't be.   
Employee data not supplied but should be.   
Employer data not supplied but should be.   
You already specified a notice period for [date]. Select a different Effective Date or change the notice period that is effective from [date] for this employee.   
The Effective Date can't be before the Hire Date or after the Termination Date. Select a different Effective Date.   
On [date], this employee's primary job is not in a location with active notice period localization settings.   
top
 

EmployeeObject

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

EmployeeObjectID

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

Employer_Notice_Period_Data

part of: Put_Edit_Notice_Periods_Event_Data
Adds or updates an employer's notice period data for an employee's involuntary termination.
 
Parameter name Type/Value Cardinality Description Validations
Derive_Notice_Period [Choice]   boolean  [1..1]  Specifies if Workday derives the notice period from the employee's notice period eligibility rule.   
Override_Notice_Period_Data [Choice]   Override_Notice_Period_Data  [1..1]  Override Notice Period Data 
Validation Description
Notice Period: Adjustments localization for [Country] is off.   
 
top
 

Override_Notice_Period_Data

part of: Employer_Notice_Period_Data, Employee_Notice_Period_Data
Adds or updates the unit and duration for a custom notice period.
 
Parameter name Type/Value Cardinality Description Validations
Duration  decimal (20, 0) >0   [0..1]  The duration for Employer Notice Period. Example: Number of Days, Weeks, or Months.   
Unit_Reference  Date_And_Time_UnitObject  [1..1]  The Date and Time Unit. Example: Days, Weeks, or Months.   
Adjustment_Reference  Unique_IdentifierObject  [0..1]  The notice period adjustment. Example: 15th or end of month, or end of month.   
Validation Description
Notice Period: Adjustments localization for [Country] is off.   
top
 

Date_And_Time_UnitObject

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

Date_And_Time_UnitObjectID

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

Employee_Notice_Period_Data

part of: Put_Edit_Notice_Periods_Event_Data
Adds or updates notice period data for an employee's voluntary termination.
 
Parameter name Type/Value Cardinality Description Validations
Derive_Notice_Period [Choice]   boolean  [1..1]  Specifies if Workday derives the notice period from the employee's notice period eligibility rule.   
Override_Notice_Period_Data [Choice]   Override_Notice_Period_Data  [1..1]  Override Notice Period Data 
Validation Description
Notice Period: Adjustments localization for [Country] is off.   
 
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Date_And_Time_UnitReferenceEnumeration

part of: Date_And_Time_UnitObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top