Service Directory > v23.0 > Benefits_Administration > Change_Benefit_Jobs
 

Operation: Change_Benefit_Jobs

Specifies the benefit jobs for a worker.


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

Contains the request to change a worker's benefit jobs. Changing a worker's benefit jobs changes how the CRFs for benefit eligibility behave. If a worker has benefit jobs specified, then only the specified jobs will be used in the CRF calculations used to evaluate their benefit eligibility. If benefit jobs are not specified, then the HR Primary job is used for those CRFs.
 
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.   
Worker_Benefit_Jobs_Data  Worker_Benefit_Jobs_Data  [1..1]  Container to specify the Worker and select their benefit jobs, or to specify that the HR Primary job should be used for eligibility. 
Validation Description
Specified position not valid for worker.  Each position specified as a benefit job must be valid for the worker as of the effective date. If a worker once held a position, but no longer has the position as of the specified effective date, then the position cannot be used for benefit jobs. 
 
top
 

Response Element: Change_Benefit_Jobs_Response

Response to the Add Worker Benefit Jobs web service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Unique_IdentifierObject  [0..1]  The event generated by this benefit job change request.   
Worker_Reference  WorkerObject  [0..1]  The worker that this benefit jobs change applies to.   
Exception_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Business_Process_Parameters

part of: Change_Benefit_Jobs_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.
 
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.   
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, Change_Benefit_Jobs_Response, Worker_Benefit_Jobs_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
 

Worker_Benefit_Jobs_Data

part of: Change_Benefit_Jobs_Request
Container to specify the Worker and select their benefit jobs, or to specify that the HR Primary job should be used for eligibility.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Specifies the worker who's benefit jobs will be changed.   
Benefit_Jobs_Data  Benefit_Jobs_Data  [1..1]  Container for the benefit jobs settings.   
Validation Description
Specified position not valid for worker.  Each position specified as a benefit job must be valid for the worker as of the effective date. If a worker once held a position, but no longer has the position as of the specified effective date, then the position cannot be used for benefit jobs. 
top
 

Benefit_Jobs_Data

part of: Worker_Benefit_Jobs_Data
Container for specifying the benefit jobs for a worker.
 
Parameter name Type/Value Cardinality Description Validations
@Effective_Date  date  [1..1]  The date that this change to a worker's benefit jobs takes effect. If blank, the current date is used.   
Use_Primary_Job [Choice]   boolean  [1..1]  If true, the HR Primary job is used for benefit eligibility CRFs. Also, if true, there must be no position references. If false, then the specified positions will be used for benefit eligibility CRFs.   
Position_Reference [Choice]   Position_ElementObject  [1..*]  The positions that will be used for benefit eligibility CRFs. 
Validation Description
Position submitted is not filled as of the effective date.   
 
top
 

Position_ElementObject

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

Unique_IdentifierObject

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

Application_Instance_Related_Exceptions_Data

part of: Change_Benefit_Jobs_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top