Service Directory > v31.2 > Staffing > Switch_Primary_Job
 

Operation: Switch_Primary_Job

This operation will invoke the business process to switch a workers primary job with one of their additional jobs. Uses the Switch Primary Job 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: Switch_Primary_Job_Request

This web service operation is designed to switch primary jobs for a worker using the Switch Primary Job Business Process
 
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.   
Switch_Primary_Position_Request_Data  Switch_Primary_Job_Request_Data  [1..1]  Wrapper element for the Switch Primary Job web service   
top
 

Response Element: Switch_Primary_Job_Event_Response

Responds with the Event ID for the Switch Primary Job business process.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Unique_IdentifierObject  [0..1]  Responds with the Event ID for the Switch Primary Job business process.   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Business_Process_Parameters

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

Switch_Primary_Job_Request_Data

part of: Switch_Primary_Job_Request
Wrapper element for the Switch Primary Job business process.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Reference to the Worker whose primary job is being edited. 
Validation Description
The worker has pending actions that conflict with this one. Complete the pending actions before starting this new action.   
 
Effective_Date  date  [1..1]  Date that the change will be effective   
Switch_Primary_Job_Data  Switch_Primary_Job_Data  [1..1]  Wrapper element for the Switch Primary Job Event   
top
 

Switch_Primary_Job_Data

part of: Switch_Primary_Job_Request_Data
Wrapper element for the Switch Primary Job business process.
 
Parameter name Type/Value Cardinality Description Validations
Reason_Reference  Event_Classification_SubcategoryObject  [1..1]  Reason for the change of the primary job.   
Proposed_Primary_Job_Reference  Position_ElementObject  [0..1]  The worker must have an additional job in order to propose a primary job. When used in a standalone Switch Primary Job web service and the worker has only 1 additional job, Workday will automatically use the new primary job value. In Change Job and Add Additional Job web services, if no value is specified, this field will remain blank. 
Validation Description
Proposed primary job submitted is not an additional job for the worker as of the effective date.   
The proposed primary job has in progress or completed Assign Pay Group business processes after the effective date.   
The proposed primary job has an in progress or completed End Additional Job business process preventing the switch.   
The Proposed Primary Job reference is required except when this is a sub process of an Add Additional Employment or a Change Job on an Additional Employment.   
The worker has a in-progress Switch Primary Job business process. That process must be finished before this one.   
Enter an effective date that is after [date], the date of the latest completed Switch Primary Job business process.   
The worker has an in progress or completed Termination business process preventing the switch.   
The proposed primary job is an International Assignment. Switching the primary job to an International Assignment is not supported.   
Worker has version 1 payroll interface data. Switching the primary for workers with version 1 payroll interface data is not supported.   
Proposed primary job submitted is not valid for the Add Additional Job sub event. This value should be sent as blank because the job that will be used as the proposed primary job has not been created yet.   
If the parent business process is Change Job on an additional job, then that job must be the proposed primary job.   
The current primary job has an in progress or completed Assign Pay Group business process after the effective date.   
Workday currently does not support payroll processing for a worker whose primary job belongs to an external pay group and additional job belongs to a Workday pay group. This switch would result in that situation.   
The proposed primary job must have a pay group (either already defined or proposed in the web service).   
The proposed primary job has a Workday pay group and the current primary job has an external pay group. The switch is not supported in this case.   
The proposed primary job must have a pay group (either already defined or proposed in the web service).   
The current primary job must have a pay group (either already defined or proposed in the web service).   
The current primary job must have a pay group (either already defined or proposed in the web service).   
Effective date of the primary job switch is prior to worker's last completed pay calculation result. The earliest possible date is [date].   
The job switch occurs in a pay period that's being processed for the worker's current or proposed primary job's pay group. Wait until the payroll process finishes before continuing or select a later Effective Date.   
Pay calculation results are in progress for this worker. You must cancel the results before continuing.   
Retro payroll calculations are in progress.   
Retro pay calculation results are in progress for this worker. You must cancel or complete the retro results before continuing.   
The worker has pending actions that conflict with this one. Complete the pending actions before starting this new action.   
 
top
 

Event_Classification_SubcategoryObject

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

Event_Classification_SubcategoryObjectID

part of: Event_Classification_SubcategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Benefits_Event_Subcategory_ID, Change_Job_Subcategory_ID, End_Additional_Job_Subcategory_ID, Event_Classification_Subcategory_ID, General_Event_Subcategory_ID, Leave_of_Absence_Type_ID, Termination_Subcategory_ID, Undo_Move_Subcategory_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: Switch_Primary_Job_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: Switch_Primary_Job_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
 

Application_Instance_Related_Exceptions_Data

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

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top