Service Directory > v31.2 > Talent > Edit_Relocation_Preferences
 

Operation: Edit_Relocation_Preferences

This operation allows for the updating of career relocation information (willing to relocate) for an employee.


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

Request element for updating the employee's relocation preferences.
 
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.   
Edit_Relocation_Preferences_Data  Edit_Relocation_Preferences_Data  [1..1]  Contains the employee reference and relocation preferences for that employee.   
top
 

Response Element: Manage_Relocation_Preferences_Response

Contains the employee mobility event that was created from the Update request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Employee_Reference_Event_Reference  Unique_IdentifierObject  [0..1]  A unique identifier for the employee mobility event.   
top
 

Business_Process_Parameters

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

Edit_Relocation_Preferences_Data

part of: Edit_Relocation_Preferences_Request
Contains the employee reference and relocation preferences for that employee.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [1..1]  Employee Reference   
Relocation_Preference_Data  Relocation_Preference_Data  [1..1]  Contains the information about the employee's willingness to relocate as part of their job.   
top
 

EmployeeObject

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

Relocation_Preference_Data

part of: Edit_Relocation_Preferences_Data
Contains the information about the employee's willingness to relocate as part of their job.
 
Parameter name Type/Value Cardinality Description Validations
Short_Term_Relocation_Reference  Common_Boolean_EnumerationObject  [0..1]  Indicates if an employee is willing to relocate in the short term to another geographic location as part of their job.   
Short_Term_Relocation_Area__Reference  Relocation_AreaObject  [0..*]  A reference to the geographic area that the employee is willing to relocate to as part of their job. This is only valid when the employee is willing to relocate (Willing to Relocate = Yes or Maybe).   
Long_Term_Relocation_Reference  Common_Boolean_EnumerationObject  [0..1]  Indicates if an employee is willing to relocate in the long term to another geographic location as part of their job.   
Long_Term_Relocation_Area__Reference  Relocation_AreaObject  [0..*]  A reference to the geographic area that the employee is willing to relocate to as part of their job. This is only valid when the employee is willing to relocate (Willing to Relocate = Yes or Maybe).   
Additional_Information  string  [0..1]  More information about why (or why not) the employee is willing to relocate as part of their job.   
top
 

Common_Boolean_EnumerationObject

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

Common_Boolean_EnumerationObjectID

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

Relocation_AreaObject

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

Relocation_AreaObjectID

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

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
 

Common_Boolean_EnumerationReferenceEnumeration

part of: Common_Boolean_EnumerationObjectID
Base Type
string
top
 

Relocation_AreaReferenceEnumeration

part of: Relocation_AreaObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top