Service Directory > v31.2 > Staffing > Hire_Employee
 

Operation: Hire_Employee

Hires a pre-hire (new or existing) into an employee position, headcount, or job. Uses the Hire Employee business process. Note: pre-hire was previously called applicant. However, the web service operation and its elements are not yet renamed, so that existing integrations continue to work.


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

This web service operation is designed to hire an existing applicant into an Employee position or job using the Hire Employee 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.   
Hire_Employee_Data  Hire_Employee_Business_Process_Data  [1..1]  Wrapper Element for the Hire Employee business process web service and its sub business processes. 
Validation Description
Hire date cannot be earlier than the earliest hire date.  Hire date cannot be earlier than the earliest hire date. 
The position or organization is restricted to contingent workers only.  The position or organization is restricted to contingent workers only. 
Applicant has already been hired.  Applicant has already been hired. 
The position specified is either not in the organization specified or is not fillable or the organization is not job management enabled.  The position specified is either not in the organization specified or is not fillable or the organization is not job management enabled. 
A legal name is required when adding an applicant. Please include the Legal Name Data element when adding an applicant to the system for the first time.   
At least one email address, phone number or address is required to create a new applicant.   
This position is occupied by someone else as of the Effective Date.  This position is occupied by someone else as of the Effective Date. 
When Job Requisition is enabled, you're not allowed to select a position without an open job requisition.   
The position is not available as of the business process initiation date.   
Student has already been hired.   
You can’t hire someone who was purged. Create a new pre-hire.   
 
top
 

Response Element: Hire_Employee_Event_Response

Responds with the Event ID for the Hire Employee Event.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Unique_IdentifierObject  [0..1]  Event ID of the Hire Employee Event.   
Employee_Reference  WorkerObject  [0..1]  Reference to Employee if web service was automatically completed.   
Position_Reference  Position_ElementObject  [0..1]  Reference to position if web service was automatically completed.   
Applicant_Reference  ApplicantObject  [0..1]  Reference ID for the Applicant.   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Business_Process_Parameters

part of: Hire_Employee_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_Sub_Process_Parameters, Business_Process_Parameters, Financials_Business_Sub_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, National_ID_Data, Visa_ID_Data, Government_ID_Data, Passport_ID_Data, License_ID_Data, Hire_Employee_Event_Response, Union_Member_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_Sub_Process_Parameters, 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
 

Hire_Employee_Business_Process_Data

part of: Hire_Employee_Request
Wrapper Element for the Hire Employee business process web service and its sub business processes.
 
Parameter name Type/Value Cardinality Description Validations
Applicant_Reference [Choice]   ApplicantObject  [1..1]  The pre-hire that you plan to hire. The pre-hire must have a Workday profile and be eligible for hire. To hire an employee, you must enter an applicant, former worker, student, or academic affiliate, or create a new pre-hire. To create a new pre-hire, enter information into the Applicant Data section. 
Validation Description
This Applicant is Not Eligible for Hire.   
 
Former_Worker_Reference [Choice]   Former_WorkerObject  [1..1]  The former worker that you plan to hire. The former worker must have a Workday profile and be eligible for hire. To hire an employee, you must enter an applicant, former worker, student, or academic affiliate, or create a new pre-hire. To create a new pre-hire, enter information into the Applicant Data section. 
Validation Description
Verify that this former worker is eligible for hire.   
 
Student_Reference [Choice]   StudentObject  [1..1]  The student that you plan to hire. The student must have a Workday profile and be eligible for hire. To hire an employee, you must enter an applicant, former worker, student, or academic affiliate, or create a new pre-hire. To create a new pre-hire, enter information into the Applicant Data section. 
Validation Description
Hire is not allowed for inactive students.   
Hire is not allowed for unsolicited prospects.   
 
Academic_Affiliate_Reference [Choice]   Academic_AffiliateObject  [1..1]  The academic affiliate that you plan to hire. The academic affiliate must have a Workday profile and be eligible for hire. To hire an employee, you must enter an applicant, former worker, student, or academic affiliate, or create a new pre-hire. To create a new pre-hire, enter information into the Applicant Data section. 
Validation Description
You can’t hire an affiliate who’s already a worker.   
At least 1 address, phone number, or email address is required. Use the Edit Academic Affiliate Contact Information task to update the affiliate’s information.   
The affiliate has an existing hire event in progress. Complete their existing hire event.   
 
Applicant_Data [Choice]   Create_Applicant_Data  [1..1]  Data for a new Applicant if an applicant is to be created as part of the hire.   
Organization_Reference  Supervisory_OrganizationObject  [0..1]  The supervisory organization into which the person will be hired. Enter this field when hiring into a job management organization. When hiring into a position management organization, Workday uses the organization for the Position. 
Validation Description
The supervisory organization must be entered or be derivable from the Position Reference.   
Proposed supervisory organization ([org]) is not valid. It will be made inactive as of [date]. This will result in this position not having a supervisory organization.   
The proposed supervisory organization is in a Hiring Freeze. It cannot be selected.   
You do not have access to the current position to perform this transaction.   
 
Position_Reference [Choice]   Position_RestrictionsObject  [0..1]  The position restriction ID into which the employee will be hired. Only used for a position management supervisory organization. If the hire event is for a job management organization, Workday ignores this value. 
Validation Description
You do not have access to the current position to perform this transaction.  You do not have access to the current position to perform this transaction. 
 
Job_Requisition_Reference [Choice]   Job_RequisitionObject  [0..1]  The Job Requisition ID for the position that will be filled. If the Job Requisition has more than 1 position, Workday selects the job requisition with the lowest Position ID. 
Validation Description
The job requisition is not open.   
The job requisition must be for an employee.   
There is no available position for the job requisition.   
 
Hire_Date  date  [0..1]  The worker's Hire Date. The Hire Date must be on or after the effective date of any changes to the position or location. 
Validation Description
The Hire Date is required.   
The effective date ([a]) must be on or after the recruiting start date ([b]).   
Select a Hire Date that is after the applicant's last day of work in their previous job: [term_date]   
 
Hire_Employee_Event_Data  Hire_Employee_Event_Data  [1..1]  Wrapper element for the details for an Employee Hire. 
Validation Description
End Employment Date must be after Hire Date.  End Employment Date must be after Hire Date. 
Probation start date cannot be earlier than the hire date.  Probation start date cannot be earlier than the hire date. 
Probation end date cannot be earlier than probation start date.  Probation end date cannot be earlier than probation start date. 
The end employment date is required for Fixed Term employees types and cannot be entered for non-fixed term employee types.  The end employment date is required for Fixed Term employees types and cannot be entered for non-fixed term employee types. 
Enter a unique Employee ID. The ID is already in use by [Employee][EmployeeNew].  If this is a new hire, use an unused employee id - or leave it blank to have it auto generated. If this is a rehire, then the employee id must be for the employee that is related to the applicant (or left blank and the existing employee id for that employee will be used). 
 
Propose_Compensation_for_Hire_Sub_Process  Propose_Compensation_For_Employment_Sub_Business_Process  [0..1]  Wrapper element for the Propose Compensation for Hire and Offer sub business processes. If any errors are found during processing, the Auto Complete boolean will be set to False and manual processing will occur for these business processes.   
Update_ID_Information_Sub_Process  Update_ID_Information_Sub_Business_Process  [0..1]  The main element for the Change ID Business Process. This contains all the ID information and Business Processing processing parameters.   
Edit_Government_IDs_Sub_Process  Edit_Government_IDs_Sub_Business_Process  [0..1]  The main element for the Edit Government IDs Business Process. This contains all the Government IDs information and Business Processing processing parameters.   
Edit_Passports_and_Visas_Sub_Process  Edit_Passports_and_Visas_Sub_Business_Process  [0..1]  The main element for the Edit Passports and Visas Business Process. This contains all the Passports and Visas IDs.   
Edit_License_Sub_Process  Edit_Licenses_Sub_Business_Process  [0..1]  The main element for the Edit Licenses Business Process. This contains all the License IDs and Business Processing processing parameters.   
Edit_Custom_IDs_Sub_Process  Edit_Custom_IDs_Sub_Business_Process  [0..1]  The main element for the Edit Other IDs Business Process. This contains all the Custom IDs and Business Processing processing parameters.   
Edit_Assign_Organization_Sub_Process  Edit_Assign_Position_Organization_Sub_Business_Process  [0..1]  Wrapper element for the Assign Organizations to Position sub business process. If this element is submitted (Auto or Manual) as part of a Staffing event and the Position_Organization_Assignment wrapper is not submitted, then the position's organization assignments will default from the supervisory organization. 
Validation Description
The Position Organization Assignments Data element is required when Automatically Complete is True.   
 
Assign_Pay_Group_Sub_Process  Assign_Pay_Group_Sub_Business_Process  [0..1]  Wrapper element for Assign Pay Group sub business process. 
Validation Description
The Assign Pay Group Data element is required if Automatically Complete is True.   
The effective date of the pay group assignment is earlier than an existing primary job switch for this worker.   
A primary job switch is in progress for this worker.   
 
Review_Payroll_Interface_Sub_Process  Review_Payroll_Interface_Data_Sub_Business_Process  [0..1]  Wrapper for the Edit Position data for Payroll Interface sub business process.   
Request_One_Time_Payment_Sub_Process  Request_One_Time_Payment_Sub_Business_Process  [0..1]  Grant an employee a one-time payment such as a referral, spot bonus, or severance pay. Uses the Request One Time Payment business event through the web service. Can be skipped, processed automatically or processed manually. 
Validation Description
Request One Time Payment Data element must be provided if Automatically Complete is True.   
Multiple One-Time Payment is not enabled. Please enable Multiple One-Time Payment in HCM Tenant Setup - Compensation.   
 
Request_One_Time_Payment_for_Referral_Sub_Process  One-Time_Payment_for_Referral_Sub_Business_Process  [0..1]  Sub process for creating a one-time payment paid to the person who referred the hired worker.   
Request_Stock_Grant_Sub_Process  Request_Stock_Sub_Business_Process  [0..1]  Wrapper element for the Request Stock Grant sub business process. 
Validation Description
Request Stock Grant Data element is required if Automatically Complete is True   
 
Create_Workday_Account_Sub_Process  Create_Workday_Account_Sub_Business_Process  [0..1]  Wrapper to hold the business process configuration and user account details. 
Validation Description
The Create Workday Account Data element is required if Automatically Complete is True.   
 
Assign_Matrix_Organization_Sub_Process  Assign_Matrix_Organization_Sub_Business_Process  [0..1]  Encapsulates the Assign Matrix Organization sub business process. 
Validation Description
The Assign Matrix Organization Data element is required if Automatically Complete is True.   
 
Change_Personal_Information_Sub_Process  Change_Personal_Information_Sub_Business_Process  [0..1]  Wrapper for the Change Personal data sub business process that is part of the Hire and Edit Position business processes.   
Create_Provisioning_Event_Sub_Process  Create_Provisioning_Event_Sub_Business_Process  [0..1]  Launch the create provisioning system. Uses the Create Provisioning System business process. This subprocess can be skipped, processed manually or processed automatically from the web service.   
Create_Benefit_Life_Event_Sub_Process  Create_Benefit_Life_Event_Sub_Business_Process  [0..1]  Wrapper element for the Create Benefit Life Event sub business process. 
Validation Description
Create Benefit Life Event Data element is required if Automatically Complete is True.   
 
Maintain_Employee_Contracts_Sub_Business_Process  Maintain_Employee_Contracts_Sub_Business_Process  [0..1]  Wrapper element for the Maintain Employee Contracts sub business process. 
Validation Description
Maintain Employee Contracts Data element is required if Automatically Complete is True.   
You can only enter 1 Employee Contract Data element for this web service request.   
 
Edit_Service_Dates_Sub_Process  Edit_Service_Dates_Sub_Business_Process  [0..1]  This web service operation allows updates to the service dates for a worker.   
Remove_Retiree_Status_Sub_Process  Remove_Retiree_Status_Sub_Business_Process  [0..1]  Element that contains details for invoking Remove Retiree Status as sub process. 
Validation Description
Remove Retiree Status Event Data must be provided if Automatically Complete is set to True.  Remove Retiree Status Event Data must be provided if Automatically Complete is set to True. 
 
Check_Position_Budget_Sub_Process  Check_Position_Budget_Sub_Business_Process  [0..1]  Run the Check Position Budget Sub Business Process to calculate any commitments and obligations for the outbound and/or inbound positions on this event to enable budget checking.   
Assign_Costing_Allocation_Sub_Process  Assign_Costing_Allocation_Sub_Business_Process  [0..1]  Contains optional costing allocation override values   
Edit_Background_Check_Sub_Process  Edit_Background_Check_Sub_Business_Process  [0..1]  Wrapper for the Edit Background Check sub business process that is part of the Hire and Edit Position business processes.   
Add_Academic_Appointment_Sub_Process  Add_Academic_Appointment_Sub_Business_Process  [0..1]  Wrapper for the Add Academic Appointment sub business process that is part of the Hire and Edit Position business processes. 
Validation Description
The "Add Academic Appointment Data" subelement is required if "Automatically Complete" is set to true.   
 
Assign_Employee_Collective_Agreement_Sub_Process  Assign_Employee_Collective_Agreement_Sub_Business_Process  [0..1]  Wrapper to hold the business process configuration and data for Assign Employee Collective Agreement sub business process.   
Manage_Employee_Probation_Period_Sub_Business_Process  Manage_Probation_Period_Sub_Business_Process  [0..1]  Details of the Probation Period being added to the Worker 
Validation Description
The "Manage Employee Probation Period Sub Data" element is required if "Automatically Complete" is set to true.   
 
Emergency_Contacts_Sub_Process  Change_Emergency_Contacts_Sub_Business_Process  [0..1]  Wrapper for the Change Emergency Contacts sub business process that is part of the Hire and Edit Position business processes. 
Validation Description
The "Change Emergency Contacts Business Process Data" subelement is required if "Automatically Complete" is set to true.   
 
Onboarding_Setup_Sub_Process  Onboarding_Setup_Sub_Business_Process  [0..1]  Wrapper for the Onboarding Setup sub business process that is part of the Hire business process.   
Student_Employment_Eligibility_Sub_Process  Student_Employment_Eligibility_Sub_Business_Process  [0..1]  Wrapper element for the Student Employment Eligibility sub business process.   
Manage_Union_Membership_Sub_Process  Manage_Union_Membership_Sub_Business_Process  [0..1]  Wrapper for the Manage Union Membership sub business process that is part of staffing event business processes. 
Validation Description
The "Union Member Data" subelement is required if "Automatically Complete" is set to true.   
 
Edit_Notice_Periods_Sub_Process  Edit_Notice_Periods_Sub_Business_Process  [0..1]  Workday doesn't process custom employee and employer notice periods for Edit Notice Period as a subprocess of the Hire business process if the Has Notice Period checkbox is unchecked in the notice period rule 
Validation Description
The "Edit Notice Periods Data" subelement is required if "Automatically Complete" is set to true.   
 
Validation Description
Hire date cannot be earlier than the earliest hire date.  Hire date cannot be earlier than the earliest hire date. 
The position or organization is restricted to contingent workers only.  The position or organization is restricted to contingent workers only. 
Applicant has already been hired.  Applicant has already been hired. 
The position specified is either not in the organization specified or is not fillable or the organization is not job management enabled.  The position specified is either not in the organization specified or is not fillable or the organization is not job management enabled. 
A legal name is required when adding an applicant. Please include the Legal Name Data element when adding an applicant to the system for the first time.   
At least one email address, phone number or address is required to create a new applicant.   
This position is occupied by someone else as of the Effective Date.  This position is occupied by someone else as of the Effective Date. 
When Job Requisition is enabled, you're not allowed to select a position without an open job requisition.   
The position is not available as of the business process initiation date.   
Student has already been hired.   
You can’t hire someone who was purged. Create a new pre-hire.   
top
 

ApplicantObject

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

ApplicantObjectID

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

Former_WorkerObject

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

Former_WorkerObjectID

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

StudentObject

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

StudentObjectID

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

Academic_AffiliateObject

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

Academic_AffiliateObjectID

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

Create_Applicant_Data

part of: Hire_Employee_Business_Process_Data
Data for a new Applicant if an applicant is to be created as part of the hire.
 
Parameter name Type/Value Cardinality Description Validations
Applicant_ID  string  [0..1]  The reference ID for the pre-hire. Enter pre-hire information into the Applicant Data section to create a new pre-hire.   
Personal_Data  Personal_Information_Data  [0..1]  Wrapper element for Personal Data. 
Validation Description
The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position  The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position 
The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. 
Usage Type is Invalid for this Contactable.  Usage Type is Invalid for this Contactable. 
The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
Native Region is only tracked in China.  Native Region is only tracked in China. 
Hukou Type is only tracked in China.  Hukou Type is only tracked in China. 
Hukou Locality is only tracked for China.  Hukou Locality is only tracked for China. 
Hukou Region is only tracked for China.  Hukou Region is only tracked for China. 
Hukou Subregion is only tracked in China.  Hukou Subregion is only tracked in China. 
The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
You may only specify one ethnicity for this worker or pre-hire. This is defined by your system administrator and based on the country of the worker or pre-hire.   
Hukou Postal Code is only tracked for China.  Hukou Postal Code is only tracked for China. 
Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
Last Medical Exam Valid To Date must be after Last Medical Exam Date  Last Medical Exam Valid To Date must be after Last Medical Exam Date 
Last Medical Exam Date cannot be in the future  Last Medical Exam Date cannot be in the future 
The field Marital Status is required and must have a value if a Marital Status Date is entered.  The field Marital Status is required and must have a value if a Marital Status Date is entered. 
The Political Affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  The Political Affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. 
The social benefits locality data has not been activated for this location via the Maintain Localization Settings task.  The social benefits locality data has not been activated for this location via the Maintain Localization Settings task. 
The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.  The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants. 
The Additional Nationalities is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Additional Nationalities is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The field Date of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Date of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
Gender is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  Gender is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Religion is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Religion is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The Marital Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Marital Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The Political Affiliation is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Political Affiliation is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
HispaniclLatino is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  HispaniclLatino is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The field Race/Ethnicity is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Race/Ethnicity is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
 
External_Integration_ID_Data  External_Integration_ID_Data  [0..1]  Integration ID Help Text   
top
 

Personal_Information_Data

part of: Create_Applicant_Data
Wrapper element for Personal Data.
 
Parameter name Type/Value Cardinality Description Validations
Universal_ID  string  [0..1]  The universal ID uniquely identifies the Person. It remains the same for a person regardless of what roles they have. This field will be automatically populated if a sequence generator is configured in Edit Tenant Setup-System.   
Name_Data  Person_Name_Data  [0..1]  Contains the legal, preferred, and additional names for a person.   
Gender_Reference  GenderObject  [0..1]  Reference to the Gender of the person.   
Birth_Date  date  [0..1]  Person's date of birth.   
Date_of_Death  date  [0..1]  The date of a person's death. The date of death element is not valid for the following web services and will be ignored: Hire Employee, Contract Contingent Worker, and Put Applicant.   
Country_of_Birth_Reference  CountryObject  [0..1]  Country where the person was born.   
Region_of_Birth_Reference  Country_RegionObject  [0..1]  Country Region where the person was born.   
Region_of_Birth_Descriptor  string  [0..1]  Country Region where the person was born.   
City_of_Birth  string  [0..1]  Person's City of birth.   
City_of_Birth_Reference  Country_CityObject  [0..1]  Person's City of Birth.   
Marital_Status_Reference  Marital_StatusObject  [0..1]  Reference for the person's Marital Status. Marital Status Information is localized and based on the country of the location where the worker is assigned. The location effective date must be after the hire effective date.   
Marital_Status_Date  date  [0..1]  Person's Marital Status Date. 
Validation Description
The Marital Status Date cannot be before the Date of Birth  The Marital Status Date cannot be before the Date of Birth 
 
Religion_Reference  ReligionObject  [0..1]  Reference for a person's Religions.   
Disability_Status_Data  Person_Disability_Status_Data  [0..*]  Disability Status Data for a Person Security Note: This element is secured according to the security policy for the Worker Data: Disabilities domain. 
Validation Description
The worker's location context is not enabled for Disability Grade.   
The provided Disability Grade is not valid for the worker's location context or is inactive.   
The worker's location context is not enabled for Disability Degree.   
The worker's location context is not enabled for Disability Remaining Capacity.   
The worker's location context is configured to use Disability Authority Reference.   
The provided Disability Authority is not valid for the worker's location context or is inactive.   
The worker's location context is not enabled for Disability Authority.   
The provided Disability Authority Reference is not valid or inactive for the worker's location context. Or the worker's location context is not enabled for Disability Authority.   
The worker's location is not enabled for Disability Certification Location.   
The worker's location context is not enabled for Disability Certification ID.   
The worker's location context is not enabled for Disability Certification Basis.   
The provided Disability Certification Basis is not valid for the worker's location context or is inactive.   
The worker's location context is not enabled for Disability Severity Recognition Date.   
The worker's location context is not enabled for Disability FTE Toward Quota.   
The provided Disability is not valid for the worker's location context. The location context is derived from the country of the location specified for the position.   
The entered Certification Basis is not valid for the entered Disability Type  The entered Certification Basis is not valid for the entered Disability Type 
The entered Certification Authority is not valid for the entered Disability Type  The entered Certification Authority is not valid for the entered Disability Type 
The entered Disability Grade is not valid for the entered Disability Type  The entered Disability Grade is not valid for the entered Disability Type 
 
Ethnicity_Reference  EthnicityObject  [0..*]  Reference for the person's Ethnicities.   
Hispanic_or_Latino  boolean  [0..1]  Returns a true if the person's Ethnicity is Hispanic or Latino.   
Citizenship_Status_Reference  Citizenship_StatusObject  [0..*]  Person's Legal Citizenship status.   
Primary_Nationality_Reference  CountryObject  [0..1]  Person's Country of Nationality.   
Additional_Nationality_Reference  CountryObject  [0..*]  List of Additional Nationalities for the person. This is a list of countries. 
Validation Description
Please select a primary nationality or remove the additional nationality.  Please select a primary nationality or remove the additional nationality. 
Please select different primary and additional nationalities.  Please select different primary and additional nationalities. 
 
Hukou_Region_Reference  Country_RegionObject  [0..1]  Country Region on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China.   
Hukou_Subregion_Reference  Country_SubregionObject  [0..1]  Country Subregion on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China.   
Hukou_Locality  string  [0..1]  Locality on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China.   
Hukou_Postal_Code  string  [0..1]  Hukou postal code for the person. This field is only available for the country China and the person with citizenship status of China.   
Hukou_Type_Reference  Hukou_TypeObject  [0..1]  Hukou type on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China.   
Local_Hukou  boolean  [0..1]  Whether the hukou subregion of the person is local to the location of the primary job. This field is only used in a response and is not used for requests.   
Native_Region_Reference  Country_RegionObject  [0..1]  The Native Region for the person.   
Native_Region_Descriptor  string  [0..1]  The Native Region for the person.   
Personnel_File_Agency_for_Person  string  [0..1]  Personnel File Agency is used in China to indicate where Workers have their Personnel File Stored.   
Last_Medical_Exam_Date  date  [0..1]  This field tracks the date of the worker's most recent Medical Exam.   
Last_Medical_Exam_Valid_To  date  [0..1]  This field tracks the expiration date of the worker's most recent Medical Exam.   
Medical_Exam_Notes  string  [0..1]  This field tracks any comments regarding the worker's most recent Medical Exam.   
Blood_Type_Reference  Blood_TypeObject  [0..1]  Person's Blood Type.   
Military_Service_Data  Person_Military_Service_Data  [0..*]  Returns the military status for a person. Security Note: This element is secured according to the security policy for the "Military/Citizenship for Worker" domain. 
Validation Description
The Military Rank specified is not valid for Military Service Type or Country from Military Status.  The Military Rank specified is not valid for Military Service Type or Country from Military Status. 
The Military Service Type specified is not valid for Country from Military Status.  The Military Service Type specified is not valid for Country from Military Status. 
You can't assign a Military Status to a worker when their Hire Date is before the Effective Date of the Location  You can't assign a Military Status to a worker when their Hire Date is before the Effective Date of the Location 
 
Identification_Data  Person_Identification_Data  [0..1]  The id information for the person (national ids, government ids, passport ids, visa ids, license ids, custom ids). Security Note: This is secured to the following domains: My ID Information, Worker ID Information, Applicant Personal Data: ID Information   
Contact_Data  Contact_Information_Data  [0..1]  All of the person's contact data (address, phone, email, instant messenger, web address). Security Note: The response for Contact information is secured to the My Contact Information and Worker Private Contact Information domains for Get Workers and Get Payees and secured to the Applicant Data: Contact Information domain for Get Applicants web service. 
Validation Description
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request.  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request. 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
One and only one Institutional email address must be marked as primary.  One and only one Institutional email address must be marked as primary. 
One and only one Institutional phone must be marked as primary.  One and only one Institutional phone must be marked as primary. 
One and only one Institutional address must be marked as primary.  One and only one Institutional address must be marked as primary. 
One and only one Institutional instant messenger address must be marked as primary.  One and only one Institutional instant messenger address must be marked as primary. 
One and only one Institutional web address must be marked as primary.  One and only one Institutional web address must be marked as primary. 
Only one address of type International Assignment is allowed for a country.  Only one address of type International Assignment is allowed for a country. 
Only one address of type work from home is allowed.  Only one address of type work from home is allowed. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
At least one Primary Email must be specified in order to add an Additional Email  At least one Primary Email must be specified in order to add an Additional Email 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
At least one Primary Phone must be specified in order to add an Additional Phone  At least one Primary Phone must be specified in order to add an Additional Phone 
Either a phone number, or an email address must be specified for an emergency contact.  Either a phone number, or an email address must be specified for an emergency contact. 
 
Tobacco_Use  boolean  [0..1]  True if the person uses tobacco. To update a person's Tobacco Use, use the Put Worker Wellness Data web service.   
Political_Affiliation_Reference  Political_AffiliationObject  [0..1]  This field tracks the political affiliation of the person.   
Social_Benefits_Locality_Reference  Social_Benefits_LocalityObject  [0..1]  The person's Social Benefits Locality. Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.   
Relative_Name_Information_Data  Relative_Name_Information_Data  [0..1]  Wrapper element for all relative names of a person   
Validation Description
The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position  The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position 
The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. 
Usage Type is Invalid for this Contactable.  Usage Type is Invalid for this Contactable. 
The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
Native Region is only tracked in China.  Native Region is only tracked in China. 
Hukou Type is only tracked in China.  Hukou Type is only tracked in China. 
Hukou Locality is only tracked for China.  Hukou Locality is only tracked for China. 
Hukou Region is only tracked for China.  Hukou Region is only tracked for China. 
Hukou Subregion is only tracked in China.  Hukou Subregion is only tracked in China. 
The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
You may only specify one ethnicity for this worker or pre-hire. This is defined by your system administrator and based on the country of the worker or pre-hire.   
Hukou Postal Code is only tracked for China.  Hukou Postal Code is only tracked for China. 
Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
Last Medical Exam Valid To Date must be after Last Medical Exam Date  Last Medical Exam Valid To Date must be after Last Medical Exam Date 
Last Medical Exam Date cannot be in the future  Last Medical Exam Date cannot be in the future 
The field Marital Status is required and must have a value if a Marital Status Date is entered.  The field Marital Status is required and must have a value if a Marital Status Date is entered. 
The Political Affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  The Political Affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. 
The social benefits locality data has not been activated for this location via the Maintain Localization Settings task.  The social benefits locality data has not been activated for this location via the Maintain Localization Settings task. 
The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.  The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants. 
The Additional Nationalities is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Additional Nationalities is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The field Date of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Date of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
Gender is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  Gender is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Religion is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Religion is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The Marital Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Marital Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The Political Affiliation is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Political Affiliation is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
HispaniclLatino is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  HispaniclLatino is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The field Race/Ethnicity is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Race/Ethnicity is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
top
 

Person_Name_Data

part of: Personal_Information_Data, Emergency_Contact_Personal_Information_Data, Create_Academic_Affiliate_Data
Contains the legal, preferred, and additional names for a person.
 
Parameter name Type/Value Cardinality Description Validations
Legal_Name_Data  Legal_Name_Data  [0..1]  Contains the legal name for a person. A person must name one and only one legal name.   
Preferred_Name_Data  Preferred_Name_Data  [0..1]  Contains the preferred name for a person. If no preferred name is returned then the legal name is assumed to be the preferred name. If a preferred name is not provided in a request then the legal name is assumed to be the preferred name.   
Additional_Name_Data  Additional_Name_Data  [0..*]  Contains the additional names for a person, other than their legal and preferred names. Additional names are not valid for applicants.   
top
 

Legal_Name_Data

part of: Person_Name_Data
Contains the legal name for a person. A person must name one and only one legal name.
 
Parameter name Type/Value Cardinality Description Validations
Name_Detail_Data  Person_Name_Detail_Data  [1..1]  Contains the components of a name, such as the First Name and Last Name.   
top
 

Person_Name_Detail_Data

part of: Legal_Name_Data, Preferred_Name_Data, Additional_Name_Data, Relative_Name_Data
Contains the components of a name, such as the First Name and Last Name.
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Name  string  [1..1]  Contains a fully formatted name in one string that has all of its pieces in their proper place. This name is only used in a response and is not used for requests   
@Reporting_Name  string  [1..1]  Contains a fully formatted name in one string for reporting that has all of its pieces in their proper place. This name is only used in a response and is not used for request   
Country_Reference  CountryObject  [1..1]  The Country that the name is in reference to. 
Validation Description
If one local script is submitted, all required local script name fields must be submitted.   
If one western script is submitted, all required western script name fields must be submitted.   
Local name is not enabled for this country.   
 
Prefix_Data  Person_Name_Prefix_Data  [0..1]  Contains the prefixes for a name.   
First_Name  string  [0..1]  The First Name (Given Name) for a person. 
Validation Description
First Name is not setup for this country.   
First Name (or Local First Name if configured) is required for this country.   
The First Name field accepts only Western script.   
 
Middle_Name  string  [0..1]  The Middle Name for a person. 
Validation Description
Middle Name is not setup for this country.   
Middle Name (or Local Middle Name if configured) is required for this country.   
 
Last_Name  string  [0..1]  The Last Name (Family Name) for a person. 
Validation Description
Last Name is not set up for this country.   
Last Name (or Local Last Name if configured) is required for this country.   
The Last Name field accepts only Western script.   
 
Secondary_Last_Name  string  [0..1]  The Secondary Last Name (Secondary Family Name) for a person. 
Validation Description
Secondary Last Name (or Local Secondary Last Name) is required for this country.   
Last Name - Secondary is not set up for this country.   
 
Tertiary_Last_Name  string  [0..1]  The Tertiary Last Name for a person. 
Validation Description
Last Name - Tertiary is not set up for this country.   
Tertiary Last Name is required for this country.   
 
Local_Name_Detail_Data  Local_Person_Name_Detail_Data  [0..1]  Contains the name components in local script for supporting countries.   
Suffix_Data  Person_Name_Suffix_Data  [0..1]  Contains the suffixes for a name.   
Full_Name_for_Singapore_and_Malaysia  string  [0..1]  Full Person Name is used by Malaysia and Singapore. It is designed for (eliminate space between these two words) Workers in these countries to enter their Full Legal Name. It is an attribute of Global Person Name Class and is not a concatenation of First and Last Names. 
Validation Description
Full Name is not set up for this country.   
 
top
 

CountryObject

part of: Person_Name_Detail_Data, Personal_Information_Data, Personal_Information_Data, Personal_Information_Data, Address_Information_Data, National_ID_Data, Visa_ID_Data, Government_ID_Data, Passport_ID_Data, License_ID_Data, Change_Personal_Information_Data, Change_Personal_Information_Data, Change_Personal_Information_Data, Education_Achievement_Data, Generic_Personal_Information_Data, Generic_Personal_Information_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  CountryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

Person_Name_Prefix_Data

part of: Person_Name_Detail_Data
Contains the prefixes for a name.
 
Parameter name Type/Value Cardinality Description Validations
Title_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  The description of the reference to the Title of a person. 
Validation Description
Title is required for this country.   
Title is not setup for this country.   
[title] is not a valid title value for [country].   
 
Title_Descriptor  string  [0..1]  The description of the reference to the Title of a person.   
Salutation_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Form of Address for a person. This is only valid for the country of Germany. 
Validation Description
Salutation is required for this country.   
Salutation is not setup for this country.   
[salutation] is not a valid salutation value for [country].   
 
top
 

Country_Predefined_Person_Name_Component_ValueObject

part of: Person_Name_Prefix_Data, Person_Name_Prefix_Data, Person_Name_Suffix_Data, Person_Name_Suffix_Data, Person_Name_Suffix_Data, Person_Name_Suffix_Data, Person_Name_Suffix_Data, Person_Name_Suffix_Data, Person_Name_Suffix_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  Country_Predefined_Person_Name_Component_ValueObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Country_Predefined_Person_Name_Component_ValueObjectID

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

Local_Person_Name_Detail_Data

part of: Person_Name_Detail_Data
Contains the components of a name in local script, such as the First Name and Last Name, for supporting countries.
 
Parameter name Type/Value Cardinality Description Validations
@Local_Name  string  [1..1]  Contains the formatted Local Name in local script as configured for the Country   
@Local_Script  string  [1..1]  Contains the formatted Local Script Name which contains the ISO code and name.   
First_Name  string  [0..1]  Contains First Name in local script, which is generally configured to as Given Name, for supporting Countries.   
Middle_Name  string  [0..1]  Contains Middle Name in local script for supporting Countries.   
Last_Name  string  [0..1]  Contains Last Name in local script, which is generally configured as Family Name, for supporting Countries.   
Secondary_Last_Name  string  [0..1]  Contains Secondary Last Name in local script, which is generally configured as Maternal Family Name, for supporting Countries.   
First_Name_2  string  [0..1]  Contains First Name in second local script, which is generally configured as Given Name, for supporting Countries. 
Validation Description
The local First Name 2 field accepts only Kana script.   
 
Middle_Name_2  string  [0..1]  Contains Middle Name in second local script for supporting Countries.   
Last_Name_2  string  [0..1]  Contains Last Name in second local script, which is generally configured as Given Name, for supporting Countries. 
Validation Description
The local Last Name 2 field accepts only Kana script.   
 
Secondary_Last_Name_2  string  [0..1]  Contains Secondary Last Name in second local script, which is generally configured as Maternal Family Name, for supporting Countries.   
top
 

Person_Name_Suffix_Data

part of: Person_Name_Detail_Data
Contains the suffixes for a name.
 
Parameter name Type/Value Cardinality Description Validations
Social_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the description of Social Suffix for a person. 
Validation Description
Social Suffix is required for this country.   
Social Suffix is not setup for this country.   
[social suffix] is not a valid social suffix value for [country].   
 
Social_Suffix_Descriptor  string  [0..1]  A reference to the description of Social Suffix for a person.   
Academic_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Academic Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Academic Suffix is required for this country.   
Academic Suffix is not setup for this country.   
[academic suffix] is not a valid academic suffix value for [country].   
 
Hereditary_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Hereditary Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Hereditary Suffix is required for this country.   
Hereditary Suffix is not setup for this country.   
[hereditary suffix] is not a valid hereditary suffix value for [country].   
 
Honorary_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Honorary Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Honorary Suffix is required for this country.   
Honorary Suffix is not setup for this country.   
[honorary suffix] is not a valid honorary suffix value for [country].   
 
Professional_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Professional Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Professional Suffix is required for this country.   
Professional Suffix is not setup for this country.   
[professional suffix] is not a valid professional suffix value for [country].   
 
Religious_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Religious Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Religious Suffix is required for this country.   
Religious Suffix is not setup for this country.   
[religious suffix] is not a valid religious suffix value for [country].   
 
Royal_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Royal Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Royal Suffix is required for this country.   
Royal Suffix is not setup for this country.   
[royal suffix] is not a valid royal suffix value for [country].   
 
top
 

Preferred_Name_Data

part of: Person_Name_Data
Contains the preferred name for a person. If no preferred name is returned then the legal name is assumed to be the preferred name. If a preferred name is not provided in a request then the legal name is assumed to be the preferred name.
 
Parameter name Type/Value Cardinality Description Validations
Name_Detail_Data  Person_Name_Detail_Data  [1..1]  Contains the components of a name, such as the First Name and Last Name.   
top
 

Additional_Name_Data

part of: Person_Name_Data
Contains the additional names for a person, other than their legal and preferred names. Additional names are not valid for applicants.
 
Parameter name Type/Value Cardinality Description Validations
Name_Detail_Data  Person_Name_Detail_Data  [1..1]  Contains the components of a name, such as the First Name and Last Name.   
Name_Type_Reference  Additional_Name_TypeObject  [0..1]  The type of Additional Name that the name is.   
top
 

Additional_Name_TypeObject

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

Additional_Name_TypeObjectID

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

GenderObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  GenderObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

GenderObjectID

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

Country_RegionObject

part of: Personal_Information_Data, Personal_Information_Data, Personal_Information_Data, Address_Information_Data, License_ID_Data, Change_Personal_Information_Data, Change_Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_Data, Generic_Personal_Information_Data, Generic_Personal_Information_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  Country_RegionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Country_RegionObjectID

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

Country_CityObject

part of: Personal_Information_Data, Address_Information_Data, Change_Personal_Information_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  Country_CityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Country_CityObjectID

part of: Country_CityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [1..1]  The unique identifier type of a parent object   
top
 

Marital_StatusObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  Marital_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Marital_StatusObjectID

part of: Marital_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Marital_Status_Code, Marital_Status_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Country_Region_ID, Country_Subregion_Internal_ID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-2_Code  [1..1]  The unique identifier type of a parent object   
top
 

ReligionObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  ReligionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

ReligionObjectID

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

Person_Disability_Status_Data

part of: Personal_Information_Data
Wrapper element for the disability status information for the person.
 
Parameter name Type/Value Cardinality Description Validations
Disability_Reference  DisabilityObject  [1..1]  The person's Disability.   
Disability_Status_Date  date  [0..1]  The person's Disability Status Date. 
Validation Description
The Disability Status Date cannot be before the Date of Birth  The Disability Status Date cannot be before the Date of Birth 
The element Disability Reference is required if a Disability Status Date is entered.  The element Disability Reference is required if a Disability Status Date is entered. 
 
Disability_Date_Known  date  [0..1]  The date the Employer first learned about the Disability. 
Validation Description
The Disability Date Known cannot be before the Date of Birth.   
 
Disability_End_Date  date  [0..1]  The date through which the worker is considered disabled. In some countries, this is the date through which the certification for the current level of Disability is effective. 
Validation Description
The Disability End Date cannot be before the Date of Birth.   
 
Disability_Grade_Reference  Disability_GradeObject  [0..1]  A code or number that identifies the level of Disability.   
Disability_Degree  decimal (8, 2) >0   [0..1]  A percentage that identifies the worker's level of Disability as of the Disability date.   
Disability_Remaining_Capacity  decimal (8, 2) >0   [0..1]  The percentage of labor that the person may work per Physician or other Authority.   
Disability_Certification_Authority_Reference [Choice]   Disability_Certification_AuthorityObject  [0..1]  The name of the person or agency that certified the Disability.   
Disability_Certification_Authority [Choice]   string  [0..1]  The name of the person or agency that certified the Disability.   
Disability_Certified_At  string  [0..1]  The place where the person or agency certified the Disability.   
Disability_Certification_ID  string  [0..1]  The ID provided to the worker, if any.   
Disability_Certification_Basis_Reference  Disability_Certification_BasisObject  [0..1]  How the worker qualified for the Disability Certification.   
Disability_Severity_Recognition_Date  date  [0..1]  The date the Disability was recognized as severe by the recognizing Authority. 
Validation Description
The Disability Severity Recognition Date cannot be before the Date of Birth.   
 
Disability_FTE_Toward_Quota  decimal (13, 1) >0   [0..1]  The FTE that counts towards the Employer's quota for hiring the Disabled.   
Disability_Work_Restrictions  string  [0..1]  List any work restrictions that apply to the worker.   
Disability_Accommodations_Requested  string  [0..1]  Describe any accommodations requested by the worker or their Care Provider.   
Disability_Accommodations_Provided  string  [0..1]  Describe any accommodations provided by the Employer.   
Disability_Rehabilitation_Requested  string  [0..1]  Describe any rehabilitation measures requested by the worker or their Care Provider.   
Disability_Rehabilitation_Provided  string  [0..1]  Describe any rehabilitation measures provided by the Employer.   
Note  string  [0..1]  Enter any additional information related to this Disability.   
Worker_Document_Reference  Worker_DocumentObject  [0..*]  Attach a copy of the certification or other documents related to this instance of Disability.   
Disability_Status_Reference  Disability_Status_ReferenceObject  [0..1]  Reference ID for the Disability Status.   
Validation Description
The worker's location context is not enabled for Disability Grade.   
The provided Disability Grade is not valid for the worker's location context or is inactive.   
The worker's location context is not enabled for Disability Degree.   
The worker's location context is not enabled for Disability Remaining Capacity.   
The worker's location context is configured to use Disability Authority Reference.   
The provided Disability Authority is not valid for the worker's location context or is inactive.   
The worker's location context is not enabled for Disability Authority.   
The provided Disability Authority Reference is not valid or inactive for the worker's location context. Or the worker's location context is not enabled for Disability Authority.   
The worker's location is not enabled for Disability Certification Location.   
The worker's location context is not enabled for Disability Certification ID.   
The worker's location context is not enabled for Disability Certification Basis.   
The provided Disability Certification Basis is not valid for the worker's location context or is inactive.   
The worker's location context is not enabled for Disability Severity Recognition Date.   
The worker's location context is not enabled for Disability FTE Toward Quota.   
The provided Disability is not valid for the worker's location context. The location context is derived from the country of the location specified for the position.   
The entered Certification Basis is not valid for the entered Disability Type  The entered Certification Basis is not valid for the entered Disability Type 
The entered Certification Authority is not valid for the entered Disability Type  The entered Certification Authority is not valid for the entered Disability Type 
The entered Disability Grade is not valid for the entered Disability Type  The entered Disability Grade is not valid for the entered Disability Type 
top
 

DisabilityObject

part of: Person_Disability_Status_Data, Disability_Status_Sub_Data, Generic_Disability_Status_Sub_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  DisabilityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

DisabilityObjectID

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

Disability_GradeObject

part of: Person_Disability_Status_Data, Disability_Status_Sub_Data, Generic_Disability_Status_Sub_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  Disability_GradeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Disability_GradeObjectID

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

Disability_Certification_AuthorityObject

part of: Person_Disability_Status_Data, Disability_Status_Sub_Data, Generic_Disability_Status_Sub_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  Disability_Certification_AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Disability_Certification_AuthorityObjectID

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

Disability_Certification_BasisObject

part of: Person_Disability_Status_Data, Disability_Status_Sub_Data, Generic_Disability_Status_Sub_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  Disability_Certification_BasisObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Disability_Certification_BasisObjectID

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

part of: Employee_Contract_Data, Person_Disability_Status_Data, Disability_Status_Sub_Data, Generic_Disability_Status_Sub_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  Worker_DocumentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Worker_DocumentObjectID

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

Disability_Status_ReferenceObject

part of: Person_Disability_Status_Data, Disability_Status_Information_Data, Generic_Disability_Status_Information_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  Disability_Status_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Disability_Status_ReferenceObjectID

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

EthnicityObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  EthnicityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

EthnicityObjectID

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

Citizenship_StatusObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  Citizenship_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Citizenship_StatusObjectID

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

Country_SubregionObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  Country_SubregionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Country_SubregionObjectID

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

Hukou_TypeObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  Hukou_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Hukou_TypeObjectID

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

Blood_TypeObject

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

Blood_TypeObjectID

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

Person_Military_Service_Data

part of: Personal_Information_Data
Wrapper element for the military service information for the person.
 
Parameter name Type/Value Cardinality Description Validations
Status_Reference  Military_StatusObject  [1..1]  Person's Military Status. 
Validation Description
Inactive military statuses are not allowed in this request.  Inactive military statuses are not allowed in this request. 
 
Discharge_Date  date  [0..1]  Date the person was discharged from the Military.   
Status_Begin_Date  date  [0..1]  Begin Date for Military Service status.   
Military_Service_Type_Reference  Military_Service_TypeObject  [0..1]  Military Service Type.   
Military_Rank_Reference  Military_RankObject  [0..1]  Military Rank for Military Service Type.   
Notes  RichText  [0..1]  Notes for Military Service.   
Military_Service_Reference  Military_Service_ReferenceObject  [0..1]  Reference ID for Military Service.   
Validation Description
The Military Rank specified is not valid for Military Service Type or Country from Military Status.  The Military Rank specified is not valid for Military Service Type or Country from Military Status. 
The Military Service Type specified is not valid for Country from Military Status.  The Military Service Type specified is not valid for Country from Military Status. 
You can't assign a Military Status to a worker when their Hire Date is before the Effective Date of the Location  You can't assign a Military Status to a worker when their Hire Date is before the Effective Date of the Location 
top
 

Military_StatusObject

part of: Person_Military_Service_Data, Military_Service_Sub_Data, Generic_Military_Service_Sub_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  Military_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Military_StatusObjectID

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

Military_Service_TypeObject

part of: Person_Military_Service_Data, Military_Service_Sub_Data, Generic_Military_Service_Sub_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  Military_Service_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Military_Service_TypeObjectID

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

Military_RankObject

part of: Person_Military_Service_Data, Military_Service_Sub_Data, Generic_Military_Service_Sub_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  Military_RankObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Military_RankObjectID

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

Military_Service_ReferenceObject

part of: Person_Military_Service_Data, Military_Service_Information_Data, Generic_Military_Service_Information_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  Military_Service_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Military_Service_ReferenceObjectID

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

Person_Identification_Data

part of: Personal_Information_Data, Update_ID_Information_Sub_Business_Process, Create_Academic_Affiliate_Data
Wrapper for Person Identification Data. Includes National Identifiers, Government Identifiers, Visa Identifiers, Passport Identifiers, License Identifiers and Custom Identifiers.
 
Parameter name Type/Value Cardinality Description Validations
National_ID  National_ID  [0..*]  Wrapper element for all National Identifier Data. 
Validation Description
If the ID is marked for deletion, a National Identifier Shared Reference ID or National Identifier WID should be included.   
The National Identifier Shared Reference should be used with the Change Government IDs web service.   
The National Identifier Shared Reference should be used with the Change Government IDs web service.   
National Identifier with reference [nir] is marked for deletion. National ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The National ID referenced by [national identifier reference] does not belong to [person].   
National Identifier [identifier] with workday id [workday id] is not a valid national identifier for the person.   
 
Government_ID  Government_ID  [0..*]  Wrapper element for all Government Identifier Data. 
Validation Description
The Government Identifier Shared Reference should be used with the Change Government IDs web service.   
The Government Identifier Shared Reference should be used with the Change Government IDs web service.   
Government Identifier with reference [gir] is marked for deletion. Government ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
If the ID is marked for deletion, a Government Identifier Shared Reference ID or Government Identifier WID should be included   
The Government ID referenced by [government identifier reference] does not belong to [person].   
Government Identifier [identifier] with workday id [workday id] is not a valid government identifier for the person.   
 
Visa_ID  Visa_ID  [0..*]  Wrapper element for all Visa Identifier Data. 
Validation Description
The Visa Identifier Reference should be used with the Change Passports and Visas web service.   
The Visa Identifier Reference should be used with the Change Passports and Visas web service.   
If the ID is marked for deletion, a Visa Identifier Shared Reference ID should be included.   
Visa Identifier with reference [vir] is marked for deletion. Visa ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
Visa Identifier [identifier] with workday id [workday id] is not a valid visa identifier for the person.   
The Visa ID referenced by [visa identifier reference] does not belong to [person].   
 
Passport_ID  Passport_ID  [0..*]  Wrapper element for all Passport Identifier Data. 
Validation Description
The Passport Identifier Shared Reference should be used with the Change Passports and Visas web service.   
The Passport Identifier Shared Reference should be used with the Change Passports and Visas web service.   
If the ID is marked for deletion, a Passport Identifier Shared Reference ID should be included.   
Passport Identifier with reference [pir] is marked for deletion. Passport ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
Passport Identifier [identifier] with workday id [workday id] is not a valid passport identifier for the person.   
The Passport ID referenced by [passport identifier reference] does not belong to [person].   
 
License_ID  License_ID  [0..*]  Wrapper element for all License Identifier Data. 
Validation Description
The License Identifier Shared Reference should be used with the Change License web service.   
The License Identifier Shared Reference should be used with the Change License web service.   
If the ID is marked for deletion, a License Identifier Shared Reference ID should be included.   
License Identifier with reference [lir] is marked for deletion. License ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The License ID referenced by [license identifier reference] does not belong to [person].   
License Identifier [identifier] with workday id [workday id] is not a valid license identifier for the person.   
 
Custom_ID  Custom_ID  [0..*]  Wrapper element for all Custom Identifier Data. 
Validation Description
The Custom Identifier Shared Reference should be used with the Change Other IDs web service.   
The Custom Identifier Shared Reference should be used with the Change Other IDs web service.   
Custom Identifier with reference [cir] is marked for deletion. Custom ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The Custom ID referenced by [custom identifier reference] does not belong to [person].   
Custom Identifier [identifier] with workday id [workday id] is not a valid custom identifier for the person.   
 
top
 

National_ID

part of: Person_Identification_Data, Government_Identification_Data
Wrapper element for all National Identifier Data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Delete is set to True and Replace All has been set to False, the ID will be deleted when the web service is submitted. Note: The Replace All flag defaults to False if not specified in the web service   
National_ID_Reference  Unique_IdentifierObject  [0..1]  The Reference ID for the National Identifier.   
National_ID_Data  National_ID_Data  [0..1]  Wrapper element for the National Identifier Data 
Validation Description
The Identifier ID does not match the format required for the National ID Type. The Identifier ID should not contain any formatting characters.  If the Identifier ID is for a National ID Type, then formatting characters must not be included. 
National Id Type is not valid for the Country specified.  National Id Type is not valid for the Country specified. 
The ID Type ([IDType]) requires Series to also be specified.  The National ID Type specified by the ID Type requires Series. 
 
National_ID_Shared_Reference  National_Identifier_ReferenceObject  [0..1]  Shared Reference ID for National Identifiers.   
Validation Description
If the ID is marked for deletion, a National Identifier Shared Reference ID or National Identifier WID should be included.   
The National Identifier Shared Reference should be used with the Change Government IDs web service.   
The National Identifier Shared Reference should be used with the Change Government IDs web service.   
National Identifier with reference [nir] is marked for deletion. National ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The National ID referenced by [national identifier reference] does not belong to [person].   
National Identifier [identifier] with workday id [workday id] is not a valid national identifier for the person.   
top
 

Unique_IdentifierObject

part of: System_User_Data, National_ID, Government_ID, Visa_ID, Passport_ID, Custom_ID, Hire_Employee_Event_Response, Notification_Sub_Type_Configuration, Override_Notice_Period_Data, Override_Notice_Period_Data, Probation_Period_Length_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  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
 

National_ID_Data

part of: National_ID
Wrapper for National Identifier Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  National Identifier ID. 
Validation Description
Identifier ID is Required   
The National Identifier entered must be at least 4 characters.   
 
ID_Type_Reference  National_ID_TypeObject  [0..1]  National Identifier Type. 
Validation Description
National ID Type required.   
Identifier type in this request is inactive. Only active statuses are allowed.   
 
Country_Reference  CountryObject  [0..1]  Country issuing National Identifier. 
Validation Description
Country is required.   
 
Issued_Date  date  [0..1]  Date the National Identifier was issued. 
Validation Description
Enter an Issue date that is on or before the expiration date: [exp date].   
 
Expiration_Date  date  [0..1]  Expiration Date of the National Identifier.   
Verification_Date  date  [0..1]  Date the National Identifier was verified.   
Series  string  [0..1]  Series is only used for a select group of countries. Brazil, Romania, Russian Federation, Ukraine, Belarus 
Validation Description
The ID Type ([IDType]) does not allow Series to be specified.   
 
Issuing_Agency  string  [0..1]  Issuing Agency is only used for a select group of countries. Colombia, Brazil, Poland, Indonesia, Romania, Vietnam, Russian Federation, Ukraine, Belarus, France and Greece 
Validation Description
The ID Type ([IDType]) does not allow Issuing Agency to be specified.   
 
Verified_By_Reference  WorkerObject  [0..1]  Worker who verified the ID. 
Validation Description
Select a different worker in the Verified By field. The worker you entered was terminated before the Verification Date: [date].   
 
Validation Description
The Identifier ID does not match the format required for the National ID Type. The Identifier ID should not contain any formatting characters.  If the Identifier ID is for a National ID Type, then formatting characters must not be included. 
National Id Type is not valid for the Country specified.  National Id Type is not valid for the Country specified. 
The ID Type ([IDType]) requires Series to also be specified.  The National ID Type specified by the ID Type requires Series. 
top
 

National_ID_TypeObject

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

National_ID_TypeObjectID

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

National_Identifier_ReferenceObject

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

National_Identifier_ReferenceObjectID

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

Government_ID

part of: Person_Identification_Data, Government_Identification_Data
Encapsulating element for all Government Identifier data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Delete is set to True and Replace All has been set to False, the ID will be deleted when the web service is submitted. Note: The Replace All flag defaults to False if not specified in the web service   
Government_ID_Reference  Unique_IdentifierObject  [0..1]  The Reference ID for the Government Identifier.   
Government_ID_Data  Government_ID_Data  [0..1]  Wrapper element for Government Identifier Data   
Government_ID_Shared_Reference  Government_Identifier_ReferenceObject  [0..1]  Shared Reference ID for Government Identifiers.   
Validation Description
The Government Identifier Shared Reference should be used with the Change Government IDs web service.   
The Government Identifier Shared Reference should be used with the Change Government IDs web service.   
Government Identifier with reference [gir] is marked for deletion. Government ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
If the ID is marked for deletion, a Government Identifier Shared Reference ID or Government Identifier WID should be included   
The Government ID referenced by [government identifier reference] does not belong to [person].   
Government Identifier [identifier] with workday id [workday id] is not a valid government identifier for the person.   
top
 

Government_ID_Data

part of: Government_ID
Wrapper for the Government Identifier Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Government ID. 
Validation Description
Identifier ID is Required   
 
ID_Type_Reference  Government_ID_Type__All_Object  [0..1]  Government ID Type. 
Validation Description
Government ID Type required.   
[git] does not match the specified country, [country]   
Identifier type in this request is inactive. Only active statuses are allowed.   
 
Country_Reference  CountryObject  [0..1]  Country issuing the Government Identifier. 
Validation Description
Country is required.   
 
Issued_Date  date  [0..1]  Date the Government Identifier was issued. 
Validation Description
Enter an Issue date that is on or before the expiration date: [exp date].   
 
Expiration_Date  date  [0..1]  Expiration Date of the Government Identifier.   
Verification_Date  date  [0..1]  Date the Government Identifier was verified.   
Verified_by_Reference  WorkerObject  [0..1]  Worker who verified the ID. 
Validation Description
Select a different worker in the Verified By field. The worker you entered was terminated before the Verification Date: [date].   
 
top
 

Government_ID_Type__All_Object

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

Government_ID_Type__All_ObjectID

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

Government_Identifier_ReferenceObject

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

Government_Identifier_ReferenceObjectID

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

Visa_ID

part of: Person_Identification_Data, Passports_and_Visas_Identification_Data
Encapsulating element for all Visa Identifier data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Delete is set to True and Replace All has been set to False, the ID will be deleted when the web service is submitted. Note: The Replace All flag defaults to False if not specified in the web service   
Visa_ID_Reference  Unique_IdentifierObject  [0..1]  Reference ID for the Visa Identifier.   
Visa_ID_Data  Visa_ID_Data  [0..1]  Wrapper element for the Visa Identifier Data   
Visa_ID_Shared_Reference  Visa_Identifier_ReferenceObject  [0..1]  Shared Reference ID for Visa Identifiers.   
Validation Description
The Visa Identifier Reference should be used with the Change Passports and Visas web service.   
The Visa Identifier Reference should be used with the Change Passports and Visas web service.   
If the ID is marked for deletion, a Visa Identifier Shared Reference ID should be included.   
Visa Identifier with reference [vir] is marked for deletion. Visa ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
Visa Identifier [identifier] with workday id [workday id] is not a valid visa identifier for the person.   
The Visa ID referenced by [visa identifier reference] does not belong to [person].   
top
 

Visa_ID_Data

part of: Visa_ID
Wrapper element for Visa identifier data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Visa Identifier. 
Validation Description
Identifier ID is Required   
 
ID_Type_Reference  Visa_ID_TypeObject  [0..1]  Visa Identifier Type. 
Validation Description
Visa ID Type required.   
[vit] does not match the specified country, [country]   
Identifier type in this request is inactive. Only active statuses are allowed.   
 
Country_Reference  CountryObject  [0..1]  Country issuing the Visa Identifier. 
Validation Description
Country is required.   
 
Issued_Date  date  [0..1]  Date the Visa Identifier was issued. 
Validation Description
Enter an Issue date that is on or before the expiration date: [exp date].   
 
Expiration_Date  date  [0..1]  Expiration Date of the Visa Identifier.   
Verification_Date  date  [0..1]  Verification Date of the Visa Identifier.   
Verified_By_Reference  WorkerObject  [0..1]  Worker who verified the ID. 
Validation Description
Select a different worker in the Verified By field. The worker you entered was terminated before the Verification Date: [date].   
 
top
 

Visa_ID_TypeObject

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

Visa_ID_TypeObjectID

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

Visa_Identifier_ReferenceObject

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

Visa_Identifier_ReferenceObjectID

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

Passport_ID

part of: Person_Identification_Data, Passports_and_Visas_Identification_Data
Encapsulating element for all Passport Identifier data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Delete is set to True and Replace All has been set to False, the ID will be deleted when the web service is submitted. Note: The Replace All flag defaults to False if not specified in the web service   
Passport_ID_Reference  Unique_IdentifierObject  [0..1]  Reference ID for the Passport Identifier.   
Passport_ID_Data  Passport_ID_Data  [0..1]  Wrapper element for the Passport Identifier Data.   
Passport_ID_Shared_Reference  Passport_Identifier_ReferenceObject  [0..1]  Shared Reference ID for Passport Identifiers.   
Validation Description
The Passport Identifier Shared Reference should be used with the Change Passports and Visas web service.   
The Passport Identifier Shared Reference should be used with the Change Passports and Visas web service.   
If the ID is marked for deletion, a Passport Identifier Shared Reference ID should be included.   
Passport Identifier with reference [pir] is marked for deletion. Passport ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
Passport Identifier [identifier] with workday id [workday id] is not a valid passport identifier for the person.   
The Passport ID referenced by [passport identifier reference] does not belong to [person].   
top
 

Passport_ID_Data

part of: Passport_ID
Wrapper for Passport Identifier data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Passport Identifier. 
Validation Description
Identifier ID is Required   
 
ID_Type_Reference  Passport_ID_Type__All_Object  [0..1]  Passport Identifier Type. 
Validation Description
Passport ID Type required.   
[pit] does not match the specified country, [country]   
Identifier type in this request is inactive. Only active statuses are allowed.   
 
Country_Reference  CountryObject  [0..1]  Country issuing the Passport Identifier. 
Validation Description
Country is required.   
 
Issued_Date  date  [0..1]  Date the Passport Identifier was issued. 
Validation Description
Enter an Issue date that is on or before the expiration date: [exp date].   
 
Expiration_Date  date  [0..1]  Expiration Date of the Passport Identifier.   
Verification_Date  date  [0..1]  Verification Date of the Passport Identifier.   
Verified_By_Reference  WorkerObject  [0..1]  Worker who verified the ID. 
Validation Description
Select a different worker in the Verified By field. The worker you entered was terminated before the Verification Date: [date].   
 
top
 

Passport_ID_Type__All_Object

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

Passport_ID_Type__All_ObjectID

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

Passport_Identifier_ReferenceObject

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

Passport_Identifier_ReferenceObjectID

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

License_ID

part of: Person_Identification_Data, License_Identification_Data
Encapsulating element for all License Identifier data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Delete is set to True and Replace All has been set to False, the ID will be deleted when the web service is submitted. Note: The Replace All flag defaults to False if not specified in the web service   
License_ID_Reference  License_IdentifierObject  [0..1]  Reference ID for the License Identifier.   
License_ID_Data  License_ID_Data  [0..1]  Wrapper element for the License Identifier data. 
Validation Description
Only one of Country Reference, Country Region Reference, or Authority Reference is allowed.  In order to specify an issuing body for the license, only one of Country Reference, Country Region Reference, or Authority Reference is allowed. 
 
License_ID_Shared_Reference  License_Identifier_ReferenceObject  [0..1]  Shared Reference ID for License Identifiers.   
Validation Description
The License Identifier Shared Reference should be used with the Change License web service.   
The License Identifier Shared Reference should be used with the Change License web service.   
If the ID is marked for deletion, a License Identifier Shared Reference ID should be included.   
License Identifier with reference [lir] is marked for deletion. License ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The License ID referenced by [license identifier reference] does not belong to [person].   
License Identifier [identifier] with workday id [workday id] is not a valid license identifier for the person.   
top
 

License_IdentifierObject

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

License_IdentifierObjectID

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

License_ID_Data

part of: License_ID
Wrapper for License Identifier Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  License Identifier. 
Validation Description
Identifier ID is Required   
 
ID_Type_Reference  License_ID_Type__All_Object  [0..1]  License Identifier Type. 
Validation Description
License ID Type required.   
Identifier type in this request is inactive. Only active statuses are allowed.   
 
Country_Reference  CountryObject  [0..1]  Country issuing the License Identifier. No more than one Country Reference, Country Region Reference, or Authority Reference can be specified.   
Country_Region_Reference  Country_RegionObject  [0..1]  Country Region issuing the License Identifier. No more than one Country Reference, Country Region Reference, or Authority Reference can be specified.   
Country_Region_Descriptor  string  [0..1]  Country Region issuing the License Identifier. No more than one Country Reference, Country Region Reference, or Authority Reference can be specified.   
Authority_Reference  AuthorityObject  [0..1]  Authority issuing the License Identifier. No more than one Country Reference, Country Region Reference, or Authority Reference can be specified.   
License_Class  string  [0..1]  License Class.   
Issued_Date  date  [0..1]  Date the License Identifier was issued. 
Validation Description
Enter an Issue date that is on or before the expiration date: [exp date].   
 
Expiration_Date  date  [0..1]  Expiration Date of the License Identifier.   
Verification_Date  date  [0..1]  Verification Date of the License Identifier.   
Verified_By_Reference  WorkerObject  [0..1]  Worker who verified the ID. 
Validation Description
Select a different worker in the Verified By field. The worker you entered was terminated before the Verification Date: [date].   
 
Validation Description
Only one of Country Reference, Country Region Reference, or Authority Reference is allowed.  In order to specify an issuing body for the license, only one of Country Reference, Country Region Reference, or Authority Reference is allowed. 
top
 

License_ID_Type__All_Object

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

License_ID_Type__All_ObjectID

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

AuthorityObject

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

AuthorityObjectID

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

License_Identifier_ReferenceObject

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

License_Identifier_ReferenceObjectID

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

Custom_ID

part of: Person_Identification_Data, Custom_Identification_Data
Encapsulating element for all Custom Identifier data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Delete is set to True and Replace All has been set to False, the ID will be deleted when the web service is submitted. Note: The Replace All flag defaults to False if not specified in the web service   
Custom_ID_Reference  Unique_IdentifierObject  [0..1]  Reference ID for Custom Identifier.   
Custom_ID_Data  Custom_ID_Data  [0..1]  Wrapper element for Custom Identifier data.   
Custom_ID_Shared_Reference  Custom_Identifier_ReferenceObject  [0..1]  Shared Reference ID for Custom Identifiers.   
Validation Description
The Custom Identifier Shared Reference should be used with the Change Other IDs web service.   
The Custom Identifier Shared Reference should be used with the Change Other IDs web service.   
Custom Identifier with reference [cir] is marked for deletion. Custom ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The Custom ID referenced by [custom identifier reference] does not belong to [person].   
Custom Identifier [identifier] with workday id [workday id] is not a valid custom identifier for the person.   
top
 

Custom_ID_Data

part of: Custom_ID
Wrapper for Custom Identifier Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Custom Identifier. 
Validation Description
Identifier ID required. Custom ID Type specified does not have a sequence generator.   
 
ID_Type_Reference  Custom_ID_TypeObject  [0..1]  Custom Identifier Type. 
Validation Description
Custom ID Type is required.   
Identifier type in this request is inactive. Only active statuses are allowed.   
 
Issued_Date  date  [0..1]  Date the Custom Identifier was issued. 
Validation Description
Enter an Issue date that is on or before the expiration date: [exp date].   
 
Expiration_Date  date  [0..1]  Expiration Date of the Custom Identifier.   
Organization_ID_Reference  OrganizationObject  [0..1]  Organization issuing the Custom Identifier.   
Custom_Description  string  [0..1]  Description of the Custom Identifier.   
top
 

Custom_ID_TypeObject

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

Custom_ID_TypeObjectID

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

OrganizationObject

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

OrganizationObjectID

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

Custom_Identifier_ReferenceObject

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

Custom_Identifier_ReferenceObjectID

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

Contact_Information_Data

part of: Personal_Information_Data, Professional_Affiliation_Organization_Data, Emergency_Contact_Personal_Information_Data, Create_Academic_Affiliate_Data
All of the person's contact data (address, phone, email, instant messenger, web address).
 
Parameter name Type/Value Cardinality Description Validations
Address_Data  Address_Information_Data  [0..*]  Address information 
Validation Description
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Usage Type and Use For combination must be valid for Address.  Usage Type and Use For combination must be valid for Address. 
Second Address Line is required for certain countries.  Second Address Line is required for certain countries. 
Third Address Line is required for certain countries.  Third Address Line is required for certain countries. 
Fourth Address Line is required for certain countries.  Fourth Address Line is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Second Submunicipality is required for certain countries.  Second Submunicipality is required for certain countries. 
Second Address Line is not a valid address component for certain countries.  Second Address Line is not a valid address component for certain countries. 
Third Address Line is not a valid address component for certain countries.  Third Address Line is not a valid address component for certain countries. 
Fourth Address Line is not a valid address component for certain countries.  Fourth Address Line is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
A maximum of four Submunicipalities are allowed in an address.  A maximum of four Submunicipalities are allowed in an address. 
A maximum of four Subregions are allowed in an address.  A maximum of four Subregions are allowed in an address. 
A maximum of four Address Lines are allowed in an address.  A maximum of four Address Lines are allowed in an address. 
Region is required for certain countries.  Region is required for certain countries. 
Home addresses which are not additionally used as work addresses cannot be marked as public.  Home addresses which are not additionally used as work addresses cannot be marked as public. 
[postal code] is not a valid postal code for [region]  Postal Code must be valid for the Region. 
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Address Line 1 - Local is not valid for this Country.  Address Line 1 - Local is not valid for this Country. 
Municipality - Local is not a valid address component for certain countries .  Municipality - Local is not a valid address component for certain countries . 
Address Line 2 - Local is not valid for this Country.  Address Line 2 - Local is not valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not a valid address component for certain countries.  City Subdivision 1 - Local is not a valid address component for certain countries. 
City Subdivision 2 - Local is not a valid address component for certain countries.  City Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 1 - Local is not a valid address component for certain countries.  Region Subdivision 1 - Local is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not a valid address component for certain countries.  Region Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 2 is not a valid address component for certain countries.  Region Subdivision 2 is not a valid address component for certain countries. 
City Subdivision 2 is not a valid address component for certain countries.  City Subdivision 2 is not a valid address component for certain countries. 
Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country.  Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country. 
Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country.  Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country. 
Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
Address Reference is required when deleting an address  Address Reference is required when deleting an address 
Usage Data is required unless address is being deleted  Usage Data is required unless address is being deleted 
Country Reference is required unless address is being deleted  Country Reference is required unless address is being deleted 
Address deletion is not supported in this web service request  Address deletion is not supported in this web service request 
If one western script field is submitted, all required western script address fields must be submitted.  If one western script field is submitted, all required western script address fields must be submitted. 
Address Reference must match an existing (and not deleted) address in use by the worker subject of this request  Address Reference must match an existing (and not deleted) address in use by the worker subject of this request 
Use a unique Address Reference ID for each address. [ID] is already used on another address.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
You can only update addresses that belong to this customer.   
You can't use an existing address for a new customer.   
Existing addresses can't be future dated. Select an effective date that is on or before today, or create a new address with a future date.   
The Address ID must match the Address Reference.   
You can't use an existing address for a new customer request.   
You can't use an existing address for a new prospect.   
You can only update addresses that belong to this customer request.   
You can only update addresses that belong to this prospect.   
Enter a postal code in the valid format: [PostalCodeValidationMessage]   
Postal Code is required for [countryWithMustHavePostalCode]   
One or more addresses are missing a Country City reference. This field is required because the City Prompt localization is active for: [countryref].   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
International Assignment is only valid for Non-Primary Home Addresses   
Number of Days cannot be greater than 7.  Number of Days cannot be greater than 7. 
Number of Days is not allowed for the country specified.  Number of Days is not allowed for the country specified. 
You must enter a Country City reference instead of a text element because the City Prompt localization is active for: [countryref]. You entered this text element: [cityattrib] [citylocalattrib].   
You entered this Country City reference: [countrycityref]. To use this Country City reference, you must activate the City Prompt localization for: [countryref]. Perform either one of these actions: Activate the City Prompt localization. Enter a municipality instead of a Country City reference.   
Address "[ID]" is already in use by another address (possibly on another contactable). Please choose a different Address ID.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
Address Line is required for certain countries.  Address Line is required for certain countries. 
 
Phone_Data  Phone_Information_Data  [0..*]  Phone Information 
Validation Description
Invalid Usage Type and Use For combination for Phone.  Invalid Usage Type and Use For combination for Phone. 
[country code] is not a valid country code for [country iso code]   
[country iso code] is not a valid country code   
You cannot specify the same usage type more than once for an address.   
Usage Data is required unless you are deleting a phone number.  Usage Data is required unless you are deleting a phone number. 
Phone Reference is required when you delete a phone number.  Phone Reference is required when you delete a phone number. 
You can't change a primary phone to an additional phone or an additional phone to a primary phone.  You can't change a primary phone to an additional phone or an additional phone to a primary phone. 
Phone Number is required unless you are deleting a phone number.  Phone Number is required unless you are deleting a phone number. 
You can't change the Usage Type of an existing phone.  You can't change the Usage Type of an existing phone. 
When Do Not Replace All is False for all phone elements, Delete can't be True.  When Do Not Replace All is False for all phone elements, Delete can't be True. 
Invalid Phone Reference or the phone number with this Phone Reference has been deleted.  Invalid Phone Reference or the phone number with this Phone Reference has been deleted. 
Primary Phone can't be deleted when there are additional phones with the same Usage Type or the phone reference does not belong to the processing record.  Primary Phone can't be deleted when there are additional phones with the same Usage Type or the phone reference does not belong to the processing record. 
When Do Not Replace All is False for all phone elements, you can't pass a Phone Reference.  When Do Not Replace All is False for all phone elements, you can't pass a Phone Reference. 
Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data'  Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data' 
Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data'  Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data' 
Phone "[ID]" is already in use by another phone (possibly on another contactable). Please choose a different Phone ID.  The Phone ID field is for updating the value of the Phone Reference. It cannot be the same as another existing phone. 
 
Email_Address_Data  Email_Address_Information_Data  [0..*]  Email Address Information 
Validation Description
Invalid Usage Type and Use For combination for Email Address.  Invalid Usage Type and Use For combination for Email Address. 
You cannot specify the same usage type more than once for an address.   
Email Reference is required when you delete an email address  Email Reference is required when you delete an email address 
Usage Data is required unless you are deleting an email address.  Usage Data is required unless you are deleting an email address. 
Email Address is required unless you are deleting an email address.  Email Address is required unless you are deleting an email address. 
When Do Not Replace All is False for all email elements, you can't pass an Email Reference.  When Do Not Replace All is False for all email elements, you can't pass an Email Reference. 
When Do Not Replace All is False for all email elements, Delete can't be True.  When Do Not Replace All is False for all email elements, Delete can't be True. 
You can't change a primary email to an additional email or an additional email to a primary email.  You can't change a primary email to an additional email or an additional email to a primary email. 
You can't change the Usage Type of an existing email address.  You can't change the Usage Type of an existing email address. 
Primary Email Address can't be deleted when there are additional email addresses with the same Usage Type or the email address reference does not belong to the processing record.  Primary Email Address can't be deleted when there are additional email addresses with the same Usage Type or the email address reference does not belong to the processing record. 
Invalid Email Reference or the email with this Email Reference has been deleted.  Invalid Email Reference or the email with this Email Reference has been deleted. 
Email "[ID]" is already in use by another email address (possibly on another contactable). Please choose a different Email ID.  The Email ID field is for updating the value of the Email Reference. It cannot be the same as another existing email. 
 
Instant_Messenger_Data  Instant_Messenger_Information_Data  [0..*]  Instant Messenger Information 
Validation Description
Invalid Usage Type and Use For combination for Instant Messenger Address.  Invalid Usage Type and Use For combination for Instant Messenger Address. 
You cannot specify the same usage type more than once for an address.   
You can't change the Usage Type of an existing Instant Messenger  You can't change the Usage Type of an existing Instant Messenger 
Primary Instant Messenger can't be deleted when there are additional instant messengers with the same Usage Type or the instant messenger reference does not belong to the processing record.  Primary Instant Messenger can't be deleted when there are additional instant messengers with the same Usage Type or the instant messenger reference does not belong to the processing record. 
You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger  You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger 
Instant Messenger Data and Usage Data is required unless you are deleting an Instant Messenger.  Instant Messenger Data and Usage Data is required unless you are deleting an Instant Messenger. 
When Do Not Replace All is False for all Instant Messenger elements, Delete can't be True.  When Do Not Replace All is False for all Instant Messenger elements, Delete can't be True. 
Invalid Instant Messenger Reference or the Instant Messenger with this Reference has been deleted.  Invalid Instant Messenger Reference or the Instant Messenger with this Reference has been deleted. 
When Do Not Replace All is False for all Instant Messenger elements, you can't pass an Instant Messenger Reference.  When Do Not Replace All is False for all Instant Messenger elements, you can't pass an Instant Messenger Reference. 
Instant Messenger Reference is required when you delete an instant messenger.  Instant Messenger Reference is required when you delete an instant messenger. 
Instant Messenger is required unless you are deleting an instant messenger.  Instant Messenger is required unless you are deleting an instant messenger. 
Instant Messenger "[ID]" is already in use by another instant messenger (possibly on another contactable). Please choose a different Instant Messenger ID.  The Instant Messenger ID field is for updating the value of the Instant Messenger Reference. It cannot be the same as another existing instant messenger. 
 
Web_Address_Data  Web_Address_Information_Data  [0..*]  Web Address Information 
Validation Description
Invalid Usage Type and Use For combination for Web Address.  Invalid Usage Type and Use For combination for Web Address. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Usage Data is required unless you are deleting a Web Address.  Usage Data is required unless you are deleting a Web Address. 
Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type or the web address reference does not belong to the processing record.  Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type or the web address reference does not belong to the processing record. 
When Do Not Replace All is False for all web address elements, you can't pass a Web Address Reference.  When Do Not Replace All is False for all web address elements, you can't pass a Web Address Reference. 
You can't change a primary web address to an additional web address or an additional web address to a primary web address.  You can't change a primary web address to an additional web address or an additional web address to a primary web address. 
When Do Not Replace All is False for all web address elements, Delete can't be True.  When Do Not Replace All is False for all web address elements, Delete can't be True. 
Invalid Web Address Reference or the Web Address with this Reference has been deleted.  Invalid Web Address Reference or the Web Address with this Reference has been deleted. 
Web Address Reference is required when you delete a web address.  Web Address Reference is required when you delete a web address. 
Web Address is required unless you are deleting a web address.  Web Address is required unless you are deleting a web address. 
You can't change the Usage Type of an existing Web Address  You can't change the Usage Type of an existing Web Address 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
Web Address "[ID]" is already in use by another web address (possibly on another contactable). Please choose a different Web Address ID.  The Web Address ID field is for updating the value of the Web Address Reference. It cannot be the same as another existing web address. 
 
Validation Description
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request.  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request. 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
One and only one Institutional email address must be marked as primary.  One and only one Institutional email address must be marked as primary. 
One and only one Institutional phone must be marked as primary.  One and only one Institutional phone must be marked as primary. 
One and only one Institutional address must be marked as primary.  One and only one Institutional address must be marked as primary. 
One and only one Institutional instant messenger address must be marked as primary.  One and only one Institutional instant messenger address must be marked as primary. 
One and only one Institutional web address must be marked as primary.  One and only one Institutional web address must be marked as primary. 
Only one address of type International Assignment is allowed for a country.  Only one address of type International Assignment is allowed for a country. 
Only one address of type work from home is allowed.  Only one address of type work from home is allowed. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
At least one Primary Email must be specified in order to add an Additional Email  At least one Primary Email must be specified in order to add an Additional Email 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
At least one Primary Phone must be specified in order to add an Additional Phone  At least one Primary Phone must be specified in order to add an Additional Phone 
Either a phone number, or an email address must be specified for an emergency contact.  Either a phone number, or an email address must be specified for an emergency contact. 
top
 

Address_Information_Data

part of: Contact_Information_Data
Address information
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Address  string  [1..1]  Returns the formatted address in the format specified for the country. This data is not used for inbound requests and any data provided in this element will be ignored.   
@Address_Format_Type  string  [1..1]  The format type of the address.   
@Defaulted_Business_Site_Address  boolean  [1..1]  Set to 1 if the address is a defaulted location address. If this value is 1, this address will not be processed for inbound web services.   
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced address. If this flag is set, the Reference ID field becomes required, and all other address fields that would otherwise be required will be optional and meaningless. 
Validation Description
The referenced address is in use as a primary home address and cannot be deleted.  The referenced address is in use as a primary home address and cannot be deleted. 
 
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary address data will be replaced. A value of true means only the referenced address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY address in the request.   
@Effective_Date  date  [1..1]  Effective date of address.   
Country_Reference  CountryObject  [0..1]  Country for the address.   
Last_Modified  dateTime  [0..1]  The moment when the address was last modified.   
Address_Line_Data  Address_Line_Information_Data  [0..*]  The address line for the address. This typically contains Street name, street number, apartment, suite number. 
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
 
Municipality  string  [0..1]  City part of the address.   
Country_City_Reference  Country_CityObject  [0..1]  Country city for the address.   
Submunicipality_Data  Submunicipality_Information_Data  [0..*]  The submunicipality of the address.   
Country_Region_Reference  Country_RegionObject  [0..1]  The region part of the address. Typically this contains the state/province information.   
Country_Region_Descriptor  string  [0..1]  The region part of the address. Typically this contains the state/province information.   
Subregion_Data  Subregion_Information_Data  [0..*]  The subregion part of the address.   
Postal_Code  string  [0..1]  The postal code part of the address.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Number_of_Days  decimal (1, 0) >0   [0..1]  Tracks the number of days an employee works from home per week.   
Municipality_Local  string  [0..1]  City in local script part of the address.   
Address_Reference  Address_ReferenceObject  [0..1]  The address Reference ID.   
Address_ID  string  [0..1]  New ID value used in address updates. The ID cannot already be in use by another address.   
Validation Description
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Usage Type and Use For combination must be valid for Address.  Usage Type and Use For combination must be valid for Address. 
Second Address Line is required for certain countries.  Second Address Line is required for certain countries. 
Third Address Line is required for certain countries.  Third Address Line is required for certain countries. 
Fourth Address Line is required for certain countries.  Fourth Address Line is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Second Submunicipality is required for certain countries.  Second Submunicipality is required for certain countries. 
Second Address Line is not a valid address component for certain countries.  Second Address Line is not a valid address component for certain countries. 
Third Address Line is not a valid address component for certain countries.  Third Address Line is not a valid address component for certain countries. 
Fourth Address Line is not a valid address component for certain countries.  Fourth Address Line is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
A maximum of four Submunicipalities are allowed in an address.  A maximum of four Submunicipalities are allowed in an address. 
A maximum of four Subregions are allowed in an address.  A maximum of four Subregions are allowed in an address. 
A maximum of four Address Lines are allowed in an address.  A maximum of four Address Lines are allowed in an address. 
Region is required for certain countries.  Region is required for certain countries. 
Home addresses which are not additionally used as work addresses cannot be marked as public.  Home addresses which are not additionally used as work addresses cannot be marked as public. 
[postal code] is not a valid postal code for [region]  Postal Code must be valid for the Region. 
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Address Line 1 - Local is not valid for this Country.  Address Line 1 - Local is not valid for this Country. 
Municipality - Local is not a valid address component for certain countries .  Municipality - Local is not a valid address component for certain countries . 
Address Line 2 - Local is not valid for this Country.  Address Line 2 - Local is not valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not a valid address component for certain countries.  City Subdivision 1 - Local is not a valid address component for certain countries. 
City Subdivision 2 - Local is not a valid address component for certain countries.  City Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 1 - Local is not a valid address component for certain countries.  Region Subdivision 1 - Local is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not a valid address component for certain countries.  Region Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 2 is not a valid address component for certain countries.  Region Subdivision 2 is not a valid address component for certain countries. 
City Subdivision 2 is not a valid address component for certain countries.  City Subdivision 2 is not a valid address component for certain countries. 
Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country.  Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country. 
Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country.  Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country. 
Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
Address Reference is required when deleting an address  Address Reference is required when deleting an address 
Usage Data is required unless address is being deleted  Usage Data is required unless address is being deleted 
Country Reference is required unless address is being deleted  Country Reference is required unless address is being deleted 
Address deletion is not supported in this web service request  Address deletion is not supported in this web service request 
If one western script field is submitted, all required western script address fields must be submitted.  If one western script field is submitted, all required western script address fields must be submitted. 
Address Reference must match an existing (and not deleted) address in use by the worker subject of this request  Address Reference must match an existing (and not deleted) address in use by the worker subject of this request 
Use a unique Address Reference ID for each address. [ID] is already used on another address.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
You can only update addresses that belong to this customer.   
You can't use an existing address for a new customer.   
Existing addresses can't be future dated. Select an effective date that is on or before today, or create a new address with a future date.   
The Address ID must match the Address Reference.   
You can't use an existing address for a new customer request.   
You can't use an existing address for a new prospect.   
You can only update addresses that belong to this customer request.   
You can only update addresses that belong to this prospect.   
Enter a postal code in the valid format: [PostalCodeValidationMessage]   
Postal Code is required for [countryWithMustHavePostalCode]   
One or more addresses are missing a Country City reference. This field is required because the City Prompt localization is active for: [countryref].   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
International Assignment is only valid for Non-Primary Home Addresses   
Number of Days cannot be greater than 7.  Number of Days cannot be greater than 7. 
Number of Days is not allowed for the country specified.  Number of Days is not allowed for the country specified. 
You must enter a Country City reference instead of a text element because the City Prompt localization is active for: [countryref]. You entered this text element: [cityattrib] [citylocalattrib].   
You entered this Country City reference: [countrycityref]. To use this Country City reference, you must activate the City Prompt localization for: [countryref]. Perform either one of these actions: Activate the City Prompt localization. Enter a municipality instead of a Country City reference.   
Address "[ID]" is already in use by another address (possibly on another contactable). Please choose a different Address ID.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
Address Line is required for certain countries.  Address Line is required for certain countries. 
top
 

Address_Line_Information_Data

part of: Address_Information_Data
The address line for the address. This typically contains Street name, street number, apartment, suite number.
 
Parameter name Type/Value Cardinality Description Validations
#text  string     
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
 
@Descriptor  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Apartment Number or Building Number) that helps describe the usage of the type (such as ADDRESS_LINE_5 and ADDRESS_LINE_6) for each country.   
@Type  string  [1..1]  Enter the address line type, such as ADDRESS_LINE_1, or ADDRESS_LINE_2.   
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
top
 

Submunicipality_Information_Data

part of: Address_Information_Data
The submunicipality of the address.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@Address_Component_Name  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Municipality or District) that helps describe the usage of the type (such as CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2) for each country.   
@Type  string  [1..1]  The city subdivision part of the address.   
top
 

Subregion_Information_Data

part of: Address_Information_Data
The subregion part of the address.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@Descriptor  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Municipality or District) that helps describe the usage of the type (such as REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2) for each country.   
@Type  string  [1..1]  Enter the region subdivision type, such as REGION_SUBDIVISION_1, or REGION_SUBDIVISION_2.   
top
 

Communication_Method_Usage_Information_Data

part of: Address_Information_Data, Phone_Information_Data, Email_Address_Information_Data, Instant_Messenger_Information_Data, Web_Address_Information_Data
Encapsulating element for all Communication Method Usage data.
 
Parameter name Type/Value Cardinality Description Validations
@Public  boolean  [1..1]  Indicates if the address is public.   
Type_Data  Communication_Usage_Type_Data  [1..*]  Reference ID for the communication usage type.   
Use_For_Reference  Communication_Usage_BehaviorObject  [0..*]  Reference ID for communication usage behavior.   
Use_For_Tenanted_Reference  Communication_Usage_Behavior_TenantedObject  [0..*]  Reference ID for communication usage behavior tenanted.   
Comments  string  [0..1]  Description of the address, phone, email, instant messenger, or web address.   
top
 

Communication_Usage_Type_Data

part of: Communication_Method_Usage_Information_Data
Reference ID for the communication usage type.
 
Parameter name Type/Value Cardinality Description Validations
@Primary  boolean  [1..1]  Indicates if the communication method is primary.   
Type_Reference  Communication_Usage_TypeObject  [1..1]  Reference ID for the communication usage type.   
top
 

Communication_Usage_TypeObject

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

Communication_Usage_TypeObjectID

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

Communication_Usage_BehaviorObject

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

Communication_Usage_BehaviorObjectID

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

Communication_Usage_Behavior_TenantedObject

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

Communication_Usage_Behavior_TenantedObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Phone_Information_Data

part of: Contact_Information_Data
Phone Information
 
Parameter name Type/Value Cardinality Description Validations
@Area_Code  string  [1..1]  Area code number. 
Validation Description
Enter an area code in the valid format: [AreaCodeValidationMessage]   
 
@Tenant_Formatted_Phone  string  [1..1]  The Phone Number formatted according to tenant setup. This data is not used in inbound requests. Any data provided for this attribute will be ignored.   
@International_Formatted_Phone  string  [1..1]  The formatted International Phone number with Extension. This data is not used in inbound requests. Any data provided for this attribute will be ignored.   
@Phone_Number_Without_Area_Code  string  [1..1]  The Phone number. This data is not used in inbound requests.   
@National_Formatted_Phone  string  [1..1]  The formatted National Phone number with Extension. This data is not used in inbound requests.   
@E164_Formatted_Phone  string  [1..1]  The formatted E164 Phone number with Extension. This data is not used in inbound requests.   
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced communication method. If this flag is set, the Reference ID field becomes required, and all other communication method fields that would otherwise be required will be optional and meaningless.   
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary phone data will be replaced. A value of true means only the referenced phone will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY email address in the request.   
Country_ISO_Code  string (3)   [0..1]  Country ISO code. If the Country ISO code is specified, then this ISO code will be used to determine the Country Phone Code for (eliminate space between f and o) the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, 1 is the Country Phone Code that is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica, and Puerto Rico.)   
International_Phone_Code  string  [0..1]  International phone code number.   
Phone_Number  string  [0..1]  Full phone number. 
Validation Description
Invalid number: [PhoneValidationMessage]   
Only Numbers are allowed for Phone Number field when the Country associated with the Phone is listed in the 'Allowed Phone Validations' field in Tenant Setup - Global   
 
Phone_Extension  string  [0..1]  Phone extension.   
Phone_Device_Type_Reference  Phone_Device_TypeObject  [0..1]  Reference ID for Phone Device Type.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Phone_Reference  Phone_ReferenceObject  [0..1]  The Phone Reference ID.   
ID  string  [0..1]  New ID value used in phone updates. The ID cannot already be in use by another phone.   
Validation Description
Invalid Usage Type and Use For combination for Phone.  Invalid Usage Type and Use For combination for Phone. 
[country code] is not a valid country code for [country iso code]   
[country iso code] is not a valid country code   
You cannot specify the same usage type more than once for an address.   
Usage Data is required unless you are deleting a phone number.  Usage Data is required unless you are deleting a phone number. 
Phone Reference is required when you delete a phone number.  Phone Reference is required when you delete a phone number. 
You can't change a primary phone to an additional phone or an additional phone to a primary phone.  You can't change a primary phone to an additional phone or an additional phone to a primary phone. 
Phone Number is required unless you are deleting a phone number.  Phone Number is required unless you are deleting a phone number. 
You can't change the Usage Type of an existing phone.  You can't change the Usage Type of an existing phone. 
When Do Not Replace All is False for all phone elements, Delete can't be True.  When Do Not Replace All is False for all phone elements, Delete can't be True. 
Invalid Phone Reference or the phone number with this Phone Reference has been deleted.  Invalid Phone Reference or the phone number with this Phone Reference has been deleted. 
Primary Phone can't be deleted when there are additional phones with the same Usage Type or the phone reference does not belong to the processing record.  Primary Phone can't be deleted when there are additional phones with the same Usage Type or the phone reference does not belong to the processing record. 
When Do Not Replace All is False for all phone elements, you can't pass a Phone Reference.  When Do Not Replace All is False for all phone elements, you can't pass a Phone Reference. 
Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data'  Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data' 
Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data'  Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data' 
Phone "[ID]" is already in use by another phone (possibly on another contactable). Please choose a different Phone ID.  The Phone ID field is for updating the value of the Phone Reference. It cannot be the same as another existing phone. 
top
 

Phone_Device_TypeObject

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

Phone_Device_TypeObjectID

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

Phone_ReferenceObject

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

Phone_ReferenceObjectID

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

Email_Address_Information_Data

part of: Contact_Information_Data
Email Address Information
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced email. If this flag is set, the Reference ID field becomes required, and all other email fields that would otherwise be required will be optional and meaningless.   
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary email address data will be replaced. A value of true means only the referenced email address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY email address in the request.   
Email_Address  string  [0..1]  Email Address Information 
Validation Description
Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com.   
 
Email_Comment  string  [0..1]  Email comments.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Email_Reference  Email_ReferenceObject  [0..1]  The email Reference ID.   
ID  string  [0..1]  New ID value used in email address updates. The ID cannot already be in use by another email address.   
Validation Description
Invalid Usage Type and Use For combination for Email Address.  Invalid Usage Type and Use For combination for Email Address. 
You cannot specify the same usage type more than once for an address.   
Email Reference is required when you delete an email address  Email Reference is required when you delete an email address 
Usage Data is required unless you are deleting an email address.  Usage Data is required unless you are deleting an email address. 
Email Address is required unless you are deleting an email address.  Email Address is required unless you are deleting an email address. 
When Do Not Replace All is False for all email elements, you can't pass an Email Reference.  When Do Not Replace All is False for all email elements, you can't pass an Email Reference. 
When Do Not Replace All is False for all email elements, Delete can't be True.  When Do Not Replace All is False for all email elements, Delete can't be True. 
You can't change a primary email to an additional email or an additional email to a primary email.  You can't change a primary email to an additional email or an additional email to a primary email. 
You can't change the Usage Type of an existing email address.  You can't change the Usage Type of an existing email address. 
Primary Email Address can't be deleted when there are additional email addresses with the same Usage Type or the email address reference does not belong to the processing record.  Primary Email Address can't be deleted when there are additional email addresses with the same Usage Type or the email address reference does not belong to the processing record. 
Invalid Email Reference or the email with this Email Reference has been deleted.  Invalid Email Reference or the email with this Email Reference has been deleted. 
Email "[ID]" is already in use by another email address (possibly on another contactable). Please choose a different Email ID.  The Email ID field is for updating the value of the Email Reference. It cannot be the same as another existing email. 
top
 

Email_ReferenceObject

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

Email_ReferenceObjectID

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

Instant_Messenger_Information_Data

part of: Contact_Information_Data
Instant Messenger Address.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced instant messenger. If this flag is set, the Reference ID field becomes required, and all other instant messenger fields that would otherwise be required will be optional and meaningless.   
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary instant messenger data will be replaced. A value of true means only the referenced instant messenger will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY instant messenger in the request.   
Instant_Messenger_Address  string  [0..1]  Instant Messenger Address.   
Instant_Messenger_Type_Reference  Instant_Messenger_TypeObject  [0..1]  Reference ID for the instant messenger type. 
Validation Description
You must provide an Instant Messenger Type.   
 
Instant_Messenger_Comment  string  [0..1]  Instant messenger comment.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Instant_Messenger_Reference  Instant_Messenger_ReferenceObject  [0..1]  The Instant Messenger Reference   
ID  string  [0..1]  New ID value used in instant messenger updates. The ID cannot already be in use by another instant messenger.   
Validation Description
Invalid Usage Type and Use For combination for Instant Messenger Address.  Invalid Usage Type and Use For combination for Instant Messenger Address. 
You cannot specify the same usage type more than once for an address.   
You can't change the Usage Type of an existing Instant Messenger  You can't change the Usage Type of an existing Instant Messenger 
Primary Instant Messenger can't be deleted when there are additional instant messengers with the same Usage Type or the instant messenger reference does not belong to the processing record.  Primary Instant Messenger can't be deleted when there are additional instant messengers with the same Usage Type or the instant messenger reference does not belong to the processing record. 
You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger  You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger 
Instant Messenger Data and Usage Data is required unless you are deleting an Instant Messenger.  Instant Messenger Data and Usage Data is required unless you are deleting an Instant Messenger. 
When Do Not Replace All is False for all Instant Messenger elements, Delete can't be True.  When Do Not Replace All is False for all Instant Messenger elements, Delete can't be True. 
Invalid Instant Messenger Reference or the Instant Messenger with this Reference has been deleted.  Invalid Instant Messenger Reference or the Instant Messenger with this Reference has been deleted. 
When Do Not Replace All is False for all Instant Messenger elements, you can't pass an Instant Messenger Reference.  When Do Not Replace All is False for all Instant Messenger elements, you can't pass an Instant Messenger Reference. 
Instant Messenger Reference is required when you delete an instant messenger.  Instant Messenger Reference is required when you delete an instant messenger. 
Instant Messenger is required unless you are deleting an instant messenger.  Instant Messenger is required unless you are deleting an instant messenger. 
Instant Messenger "[ID]" is already in use by another instant messenger (possibly on another contactable). Please choose a different Instant Messenger ID.  The Instant Messenger ID field is for updating the value of the Instant Messenger Reference. It cannot be the same as another existing instant messenger. 
top
 

Instant_Messenger_TypeObject

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

Instant_Messenger_TypeObjectID

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

Instant_Messenger_ReferenceObject

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

Instant_Messenger_ReferenceObjectID

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

Web_Address_Information_Data

part of: Contact_Information_Data
Web Address Information
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced communication method. If this flag is set, the Reference ID field becomes required, and all other communication method fields that would otherwise be required will be optional and meaningless.   
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary web address data will be replaced. A value of true means only the referenced web address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY web address in the request.   
Web_Address  string  [0..1]  Web address (Example: URL).   
Web_Address_Comment  string  [0..1]  Web address comment.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Web_Address_Reference  Web_Address_ReferenceObject  [0..1]  The Web Address Reference Instance   
ID  string  [0..1]  New ID value used in web address updates. The ID cannot already be in use by another web address.   
Validation Description
Invalid Usage Type and Use For combination for Web Address.  Invalid Usage Type and Use For combination for Web Address. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Usage Data is required unless you are deleting a Web Address.  Usage Data is required unless you are deleting a Web Address. 
Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type or the web address reference does not belong to the processing record.  Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type or the web address reference does not belong to the processing record. 
When Do Not Replace All is False for all web address elements, you can't pass a Web Address Reference.  When Do Not Replace All is False for all web address elements, you can't pass a Web Address Reference. 
You can't change a primary web address to an additional web address or an additional web address to a primary web address.  You can't change a primary web address to an additional web address or an additional web address to a primary web address. 
When Do Not Replace All is False for all web address elements, Delete can't be True.  When Do Not Replace All is False for all web address elements, Delete can't be True. 
Invalid Web Address Reference or the Web Address with this Reference has been deleted.  Invalid Web Address Reference or the Web Address with this Reference has been deleted. 
Web Address Reference is required when you delete a web address.  Web Address Reference is required when you delete a web address. 
Web Address is required unless you are deleting a web address.  Web Address is required unless you are deleting a web address. 
You can't change the Usage Type of an existing Web Address  You can't change the Usage Type of an existing Web Address 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
Web Address "[ID]" is already in use by another web address (possibly on another contactable). Please choose a different Web Address ID.  The Web Address ID field is for updating the value of the Web Address Reference. It cannot be the same as another existing web address. 
top
 

Web_Address_ReferenceObject

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

Web_Address_ReferenceObjectID

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

Political_AffiliationObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  Political_AffiliationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Political_AffiliationObjectID

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

Social_Benefits_LocalityObject

part of: Personal_Information_Data, Change_Personal_Information_Data, Generic_Personal_Information_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  Social_Benefits_LocalityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Social_Benefits_LocalityObjectID

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

Relative_Name_Information_Data

part of: Personal_Information_Data, Change_Personal_Information_Data
Wrapper element for all relative names of a person
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  When this flag is set to false, existing Relative Name data for the Worker will be preserved. When true, it causes the web service to replace all Relative Name data for the Worker with the information in the request. (This is the default behavior when the entire tag is omitted.)   
Relative_Name_Data  Relative_Name_Data  [0..*]  contains relative names for a relative of a person 
Validation Description
Relative Name Reference is required when deleting a Relative Name entry   
Person Name Detail Data and Relative Type Reference are required unless the Relative Name is being deleted.   
The Relative Type provided is not from the same country as the Target: [country] . Relative Type is [relativeType] .   
 
top
 

Relative_Name_Data

part of: Relative_Name_Information_Data
contains relative names for a relative of a person
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag to delete an existing Relative Name entry. If this flag is set, Relative Name Reference is also required.   
Relative_Name_Reference_Reference  Relative_Name_ReferenceObject  [0..1]  Holds a reference to a main relative name reference, with a single instance referencing all versions of a relative name. 
Validation Description
The Relative Name Reference provided is not owned by the worker : [worker]   
 
Relative_Type_Reference  Relative_TypeObject  [0..1]  Type to specify the relative person relationship. 
Validation Description
Relative Type specified in this request is inactive. Only active statuses are allowed.  Relative Type specified in this request is inactive. Only active statuses are allowed. 
 
Name_Detail_Data  Person_Name_Detail_Data  [0..1]  Contains the components of a name, such as the First Name and Last Name.   
Validation Description
Relative Name Reference is required when deleting a Relative Name entry   
Person Name Detail Data and Relative Type Reference are required unless the Relative Name is being deleted.   
The Relative Type provided is not from the same country as the Target: [country] . Relative Type is [relativeType] .   
top
 

Relative_Name_ReferenceObject

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

Relative_Name_ReferenceObjectID

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

Relative_TypeObject

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

Relative_TypeObjectID

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

External_Integration_ID_Data

part of: Create_Applicant_Data
Integration ID Help Text
 
Parameter name Type/Value Cardinality Description Validations
ID  ID  [1..*]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

ID

part of: External_Integration_ID_Data
External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@System_ID  string  [1..1]  Integration system identifier, part of a two part key (including the text value of the ID element) that uniquely identify integratable object. 
Validation Description
Integration System ID does not exist.  A valid instance of Integration ID must exist for the given System ID. 
 
top
 

Supervisory_OrganizationObject

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

Supervisory_OrganizationObjectID

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

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

Position_RestrictionsObjectID

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

Job_RequisitionObject

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

Job_RequisitionObjectID

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

Hire_Employee_Event_Data

part of: Hire_Employee_Business_Process_Data
Wrapper element for the details for an Employee Hire.
 
Parameter name Type/Value Cardinality Description Validations
Employee_ID  string  [0..1]  The unique Employee ID. For a rehire: Manually enter a unique ID to change the terminated Employee ID. If left blank, Workday automatically generates the Employee ID. For a new employee: Manually enter a unique ID. If left blank, Workday automatically generates the Employee ID. If left blank for a former worker when tenant configuration enables Reuse Former Worker ID, Workday will reuse the former worker ID. If Reuse Former Worker ID isn't enabled and you leave this field blank, Workday automatically generates the Employee ID.   
Position_ID  string  [0..1]  The unique Position ID. For a position management organization, leave empty. Workday will use the existing Position ID for the position. When hiring into a job management organization: If you enter a unique ID, Workday will use that ID for the new position. If left empty, Workday will generate a unique Position ID. 
Validation Description
Do not enter a Position ID when hiring, contracting or transferring into a Position Management position. The position already has an ID.   
Position ID [id] is already in use by another position [position].   
 
Hire_Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  The reason for hiring the worker.   
Employee_Type_Reference  Position_Worker_TypeObject  [0..1]  The worker's employee type. 
Validation Description
The Employee Type is not valid for the hiring restrictions.   
Employee Type is required for an employee.   
Employee Type is not valid for the Job Requisition.   
 
First_Day_of_Work  date  [0..1]  The date of the employee's first day of work. If left empty, Workday uses the Hire Date. 
Validation Description
First day of work cannot be earlier than hire date.   
 
Time_of_Hire  time  [0..1]  The expected time that the worker will start their first day of work. Use the Maintain Localization Settings task to localize for specific countries. 
Validation Description
Time of Hire not activated for this location. Please contact your system administrator to review the Maintain Localization Settings task.   
 
Continuous_Service_Date  date  [0..1]  Date that service calculations will use as the start of service. If empty, Workday will use the existing date. When rehiring workers, if you run the Hire Employee and Edit Service Dates EIBs concurrently, you must enter the same Continuous Service Date in both EIBs for each worker.   
Probation_Start_Date  date  [0..1]  Date the employee's probation will start. Instead of using Probation_Start_Date, use the Manage Employee Probation Period Sub Business Process.   
Probation_End_Date  date  [0..1]  Date the employee's probation will end. Instead of using Probation_End_Date, use the Manage Employee Probation Period Sub Business Process.   
Employment_End_Date  date  [0..1]  The End Employment Date for the position of fixed term or temporary employees. If empty, Workday will use the existing End Employment Date.   
Benefits_Service_Date  date  [0..1]  The Benefits Service Date in the employee's service dates. If empty, Workday will use the existing date. When rehiring workers, if you run the Hire Employee and Edit Service Dates EIBs concurrently, you must enter the same Benefit Service Date in both EIBs for each worker.   
Company_Service_Date  date  [0..1]  The Company Service Date in the employee's service dates. If empty, Workday will use the existing date. When rehiring workers, if you run the Hire Employee and Edit Service Dates EIBs concurrently, you must enter the same Company Service Date in both EIBs for each worker.   
Conversion_Position_Start_Date  date  [0..1]  The employee's start date for the current position. Must be later than the Hire Date. Use only for loading existing workers during implementation. Used for Manager History and Time in Position calculations. 
Validation Description
Conversion Position Start Date cannot be earlier than the Start Date.   
 
Position_Details  Position_Details_Sub_Data  [1..1]  Wrapper element for filled position data. 
Validation Description
The job profile requires this position to have a work shift but none has been submitted.  The job profile requires this position to have a work shift but none has been submitted. 
Work shift is not valid for the location [location].  Work shift is not valid for the location. 
A Work Hours Profile is required for the position.  A Work Hours Profile is required for the position. 
Work Hours Profile is not valid for the Job Profile that was entered.  Work Hours Profile is not valid for the Job Profile that was entered. 
Pay Rate type cannot be entered for contingent workers.  Pay Rate type cannot be entered for contingent workers. 
When HCM tenant setup does not have Higher Education configured, you are not allowed to populate annual work period and disbursement plan period for the position.  When HCM tenant setup does not have Higher Education configured, you are not allowed to populate annual work period and disbursement plan period for the position. 
The job profile for the position is not within a job family that is configured for academic pay. You are not allowed to populate annual work period and disbursement plan period.  The job profile for the position is not within a job family that is configured for academic pay. You are not allowed to populate annual work period and disbursement plan period. 
If you select or enter a value for one of the fields in Working Time, you must complete all the fields in the grouping.   
Working Time fields are not enabled for the country associated with the position   
The Working Time field submitted cannot be entered for contingent workers   
 
Employee_External_ID_Data  External_ID_Data  [0..1]  Integration ID Help Text   
Validation Description
End Employment Date must be after Hire Date.  End Employment Date must be after Hire Date. 
Probation start date cannot be earlier than the hire date.  Probation start date cannot be earlier than the hire date. 
Probation end date cannot be earlier than probation start date.  Probation end date cannot be earlier than probation start date. 
The end employment date is required for Fixed Term employees types and cannot be entered for non-fixed term employee types.  The end employment date is required for Fixed Term employees types and cannot be entered for non-fixed term employee types. 
Enter a unique Employee ID. The ID is already in use by [Employee][EmployeeNew].  If this is a new hire, use an unused employee id - or leave it blank to have it auto generated. If this is a rehire, then the employee id must be for the employee that is related to the applicant (or left blank and the existing employee id for that employee will be used). 
top
 

Event_Classification_SubcategoryObject

part of: Request_One_Time_Payment_Sub_Business_Process, Hire_Employee_Event_Data, Request_Stock_Grant_Subdata, Remove_Retiree_Status_Sub_Process_Details, One-Time_Payment_for_Referral_Sub_Business_Process
 
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_Worker_TypeObject

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

Position_Worker_TypeObjectID

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

Position_Details_Sub_Data

part of: Hire_Employee_Event_Data
Wrapper element for filled position data.
 
Parameter name Type/Value Cardinality Description Validations
Job_Profile_Reference  Job_ProfileObject  [0..1]  The Job Profile for the filled position. Edit Position: If empty, Workday will use the Job Profile in the position restriction. Change Job when empty: If Headcount is equal to Backfill or Close, or when changing staffing model type with multiple job profiles available on the position restriction, enter 1 job profile. Otherwise, Workday will use the job profile in the position restriction. Hire: If empty and the position restriction has 1 job profile, Workday will use the job profile in the position restriction. Otherwise, the Job Profile is required. 
Validation Description
Job Profile is required to be submitted or be defaulted from the current value or the hiring restrictions.   
Job Profile does not meet the restrictions for the proposed Job Requisition.   
Job profile does not meet the restrictions for the proposed organization or position.   
 
Position_Title  string  [0..1]  The Position Title of the position. If empty, Workday will use the worker's existing Position Title.   
Business_Title  string  [0..1]  The Business Title of the position. If empty, Workday will use the worker's existing Business Title.   
Location_Reference  LocationObject  [0..1]  The Location for the filled position. Edit Position: If empty, Workday will use the Location in the position restriction. Change Job when empty: If Headcount is equal to Backfill or Close, or when changing staffing model type with multiple locations available on the position restriction, enter 1 location. Otherwise, Workday will use the location in the position restriction. Hire: If empty and the position restriction has 1 location, Workday will use the location in the position restriction. Otherwise, Location is required. 
Validation Description
Location is required to be submitted or defaulted.   
Location must be of usage Business Site.   
Location does not meet the restrictions of the proposed Job Requisition.   
Location does not meet the restrictions for the proposed organization or position.   
The location is not valid for a completed work space change.   
The location is not valid for an in progress work space change.   
 
Work_Space_Reference  LocationObject  [0..1]  The physical location of the worker's position. 
Validation Description
Select another location. The work space isn't valid for this location: [work space1][work space2]   
Select a work space that is valid for the location. Work space: [work space1][work space2] Location: [location1][location2][location3]   
Work space must be active.   
 
Position_Time_Type_Reference  Position_Time_TypeObject  [0..1]  The time type for the position. Example: part time or full time. If empty, Workday will use the existing time type. 
Validation Description
Time Type does not meet the restrictions for the proposed organization or position.   
Time Type is required to be submitted or derived from the existing data or from the hiring restrictions.   
Position Time Type does not meet the restrictions of the proposed Job Requisition.   
 
Work_Shift_Reference  Work_ShiftObject  [0..1]  The Work Shift of the position. If empty, Workday will use the existing Work Shift.   
Work_Hours_Profile_Reference  Work_Hours_ProfileObject  [0..1]  The Work Hours Profile of the position. Only available in tenants where work hours profiles are enabled. If empty, the Work Hours Profile is not changed.   
Default_Hours  decimal (5, 2) >0   [0..1]  The default weekly hours of the position. Required for filled positions. When the Default Hours value has never been entered: If Work Hours Profile is enabled, Workday will use the hours in the Work Hours Profile. Otherwise, Workday will use the scheduled weekly hours for the business site. If the Default Hours value has previously been entered and is left empty, Workday will use the existing Default Hours. 
Validation Description
Enter a value of 168 hours or fewer.   
 
Scheduled_Hours  decimal (14, 2)   [0..1]  The scheduled weekly hours of the position. Required for filled positions. If a value is never entered, Workday will use the Default Hours. If empty, Workday will use the existing Scheduled Hours. Changing this field will affect FTE calculations. 
Validation Description
FTE cannot be greater than 999.   
The scheduled weekly hours cannot be negative.   
Enter a value of 168 hours or fewer.   
 
Working_Time_Frequency_Reference  FrequencyObject  [0..1]  You can record details about a worker's expected schedule using the Working Time section. Enable Working Time in the Maintain Localization Settings task. Set the Working Time Frequency values in the Maintain Frequencies task.   
Working_Time_Unit_Reference  Working_Time_UnitObject  [0..1]  The Working Time Unit can be in hours or days. Enable Working Time in the Maintain Localization Settings task. Enable units in the Maintain Unit of Time task.   
Working_Time_Value  decimal (6, 2) >0   [0..1]  The numeric value of the Working Time Unit. Enable Working Time in the Maintain Localization Settings task.   
Pay_Rate_Type_Reference  Pay_Rate_TypeObject  [0..1]  The Pay Rate Type for the position. Workday ignores values specified for contingent workers. If empty, the Pay Rate Type is not changed.   
Job_Classification_Reference  Job_ClassificationObject  [0..*]  The Job Classifications that can be used for the position. If empty, Workday will use the existing classifications. 
Validation Description
Additional Job Classifications are not valid for the Location.   
 
Company_Insider_Type_Reference  Company_Insider_TypeObject  [0..*]  The Company Insider Type values for the position. If empty, Workday uses the existing Company Insider Type.   
Annual_Work_Period_Reference  Academic_Pay_PeriodObject  [0..1]  The period of time during which an academic member earns an annual salary, equal to the Academic Work Period. Used for the Academic Pay Period. 
Validation Description
Annual work period is not allowed to be populated for a contingent worker.  Annual work period is not allowed to be populated for a contingent worker. 
Please select an active annual work period.  Please select an active annual work period. 
 
Disbursement_Plan_Period_Reference  Academic_Pay_PeriodObject  [0..1]  The period of time during which an academic member receives annual compensation, equal to the Disbursement Plan Period. Used for the Academic Pay Period. 
Validation Description
Disbursement plan period is not allowed to be populated for a contingent worker.  Disbursement plan period is not allowed to be populated for a contingent worker. 
Please select an active disbursement plan period.  Please select an active disbursement plan period. 
Disbursement plan period is required when annual work period is populated.  Disbursement plan period is required when annual work period is populated. 
Please enter annual work period.  Please enter annual work period. 
You have selected an invalid disbursement plan period for the annual work period. The annual work period must fall within the disbursement period.  You have selected an invalid disbursement plan period for the annual work period. The annual work period must fall within the disbursement period. 
 
Workers__Compensation_Code_Override_Reference  Workers_Compensation_CodeObject  [0..1]  The worker's Compensation Code Override. The Compensation Code Override replaces the worker's compensation code. If a value is never entered, Workday will use the value from the Job Profile. If empty, Workday will use the existing compensation.   
Position_External_ID_Data  External_ID_Data  [0..1]  Integration ID Help Text   
Validation Description
The job profile requires this position to have a work shift but none has been submitted.  The job profile requires this position to have a work shift but none has been submitted. 
Work shift is not valid for the location [location].  Work shift is not valid for the location. 
A Work Hours Profile is required for the position.  A Work Hours Profile is required for the position. 
Work Hours Profile is not valid for the Job Profile that was entered.  Work Hours Profile is not valid for the Job Profile that was entered. 
Pay Rate type cannot be entered for contingent workers.  Pay Rate type cannot be entered for contingent workers. 
When HCM tenant setup does not have Higher Education configured, you are not allowed to populate annual work period and disbursement plan period for the position.  When HCM tenant setup does not have Higher Education configured, you are not allowed to populate annual work period and disbursement plan period for the position. 
The job profile for the position is not within a job family that is configured for academic pay. You are not allowed to populate annual work period and disbursement plan period.  The job profile for the position is not within a job family that is configured for academic pay. You are not allowed to populate annual work period and disbursement plan period. 
If you select or enter a value for one of the fields in Working Time, you must complete all the fields in the grouping.   
Working Time fields are not enabled for the country associated with the position   
The Working Time field submitted cannot be entered for contingent workers   
top
 

Job_ProfileObject

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

Job_ProfileObjectID

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

LocationObject

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

LocationObjectID

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

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

Position_Time_TypeObjectID

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

Work_ShiftObject

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

Work_ShiftObjectID

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

Work_Hours_ProfileObject

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

Work_Hours_ProfileObjectID

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

FrequencyObject

part of: Position_Details_Sub_Data, Proposed_Salary_Unit_Plan_Assignment_Data, Proposed_Allowance_Plan_Assignment_Data, Proposed_Allowance_Unit_Plan_Assignment_Data, Proposed_Commission_Plan_Assignment_Data, Proposed_Commission_Plan_Assignment_Data, Review_Payroll_Interface_Data, Proposed_Base_Pay_Plan_Job_Assignment_Data, Proposed_Period_Salary_Plan_Assignment_Data, Proposed_Calculated_Plan_Assignment_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  FrequencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

FrequencyObjectID

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

Working_Time_UnitObject

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

Working_Time_UnitObjectID

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

Pay_Rate_TypeObject

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

Pay_Rate_TypeObjectID

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

Job_ClassificationObject

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

Job_ClassificationObjectID

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

Company_Insider_TypeObject

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

Company_Insider_TypeObjectID

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

Academic_Pay_PeriodObject

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

Academic_Pay_PeriodObjectID

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

Workers_Compensation_CodeObject

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

Workers_Compensation_CodeObjectID

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

External_ID_Data

part of: Position_Details_Sub_Data, Hire_Employee_Event_Data
Integration ID Help Text
 
Parameter name Type/Value Cardinality Description Validations
External_ID  External_ID  [0..*]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

External_ID

part of: External_ID_Data
External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.
 
Parameter name Type/Value Cardinality Description Validations
@System_ID  string  [1..1]  Integration system identifier, part of a two part key (including the text value of the ID element) that uniquely identify integratable object. 
Validation Description
Integration System ID does not exist.  A valid instance of Integration ID must exist for the given System ID. 
 
External_ID  string  [1..1]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

Propose_Compensation_For_Employment_Sub_Business_Process

part of: Hire_Employee_Business_Process_Data
Wrapper element for the Propose Compensation for Hire and Offer sub business processes. If any errors are found during processing, the Auto Complete boolean will be set to False and manual processing will occur for these business processes.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-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.   
Propose_Compensation_for_Hire_Data  Compensation_Proposed_For_Employment_Data  [0..1]  Data element for the Propose Compensation for Hire business process. 
Validation Description
Primary Compensation Basis amount has to be greater than zero. If you do not wish to use Primary Compensation Basis, leave the field blank.  Primary Compensation Basis amount has to be greater than zero. If you do not wish to use Primary Compensation Basis, leave the field blank. 
 
top
 

Business_Sub_Process_Parameters

part of: Request_One_Time_Payment_Sub_Business_Process, Review_Payroll_Interface_Data_Extract_Business_Sub_Process, Assign_Matrix_Organization_Sub_Business_Process, Edit_Assign_Position_Organization_Sub_Business_Process, Assign_Pay_Group_Sub_Business_Process, Change_Personal_Information_Sub_Business_Process, Review_Payroll_Interface_Data_Sub_Business_Process, Update_ID_Information_Sub_Business_Process, Request_Stock_Sub_Business_Process, Propose_Compensation_For_Employment_Sub_Business_Process, Create_Workday_Account_Sub_Business_Process, Create_Provisioning_Event_Sub_Business_Process, Create_Benefit_Life_Event_Sub_Business_Process, Edit_Service_Dates_Sub_Business_Process, Maintain_Employee_Contracts_Sub_Business_Process, Remove_Retiree_Status_Sub_Business_Process, Edit_Government_IDs_Sub_Business_Process, Edit_Passports_and_Visas_Sub_Business_Process, Edit_Licenses_Sub_Business_Process, Edit_Custom_IDs_Sub_Business_Process, Assign_Costing_Allocation_Sub_Business_Process, Edit_Background_Check_Sub_Business_Process, Add_Academic_Appointment_Sub_Business_Process, Assign_Employee_Collective_Agreement_Sub_Business_Process, Manage_Probation_Period_Sub_Business_Process, Change_Emergency_Contacts_Sub_Business_Process, Manage_Professional_Affiliation_Sub_Business_Process_Data, Manage_Education_Sub_Business_Process_Data, Onboarding_Setup_Sub_Business_Process, Student_Employment_Eligibility_Sub_Business_Process, Manage_Instructor_Eligibility_Sub_Business_Process_Data, One-Time_Payment_for_Referral_Sub_Business_Process, Manage_Union_Membership_Sub_Business_Process, Edit_Notice_Periods_Sub_Business_Process
Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-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 [Choice]   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.   
Skip [Choice]   boolean  [0..1]  When set to "true" or "1", the business process is automatically skipped (if it is defined as "skippable" within the business process definition).   
Business_Process_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.   
top
 

Compensation_Proposed_For_Employment_Data

part of: Propose_Compensation_For_Employment_Sub_Business_Process
Data element for the Propose Compensation for Hire business process.
 
Parameter name Type/Value Cardinality Description Validations
Primary_Compensation_Basis  decimal (26, 6)   [0..1]  Sum of the worker's plan assignments as defined by their primary compensation basis.   
Compensation_Guidelines_Data  Compensatable_Guidelines_Data  [0..1]  Data element containing the compensation guidelines for a compensation change. 
Validation Description
Compensation grade profile is not valid for the compensation grade.  Compensation grade profile is not valid for the compensation grade. 
Compensation step is not valid for the compensation grade profile.  Compensation step is not valid for the compensation grade profile. 
Compensation Grade is required.  Compensation Grade is required. 
Compensation step is not valid for the compensation grade.  Compensation step is not valid for the compensation grade. 
Compensation package is required.  Compensation package is required. 
 
Pay_Plan_Data  Proposed_Base_Pay_Plan_Job_Assignment_Container_Data  [0..1]  Encapsulating element containing all Salary or Hourly Plan Compensation data.   
Unit_Salary_Plan_Data  Proposed_Salary_Unit_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Unit Salary Plan Compensation data.   
Allowance_Plan_Data  Proposed_Allowance_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Allowance Plan Compensation data.   
Unit_Allowance_Plan_Data  Proposed_Allowance_Unit_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Unit Allowance Plan Compensation data.   
Bonus_Plan_Data  Proposed_Bonus_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Bonus Plan Compensation data.   
Merit_Plan_Data  Proposed_Merit_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Merit Plan Compensation data.   
Commission_Plan_Data  Proposed_Commission_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Commission Plan Compensation data.   
Stock_Plan_Data  Proposed_Stock_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Stock Plan Compensation data.   
Period_Salary_Plan_Data  Proposed_Period_Salary_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Period Salary Plan Compensation data.   
Calculated_Plan_Data  Proposed_Calculated_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Calculated Plan Compensation data.   
Validation Description
Primary Compensation Basis amount has to be greater than zero. If you do not wish to use Primary Compensation Basis, leave the field blank.  Primary Compensation Basis amount has to be greater than zero. If you do not wish to use Primary Compensation Basis, leave the field blank. 
top
 

Compensatable_Guidelines_Data

part of: Compensation_Proposed_For_Employment_Data
Data element containing the compensation guidelines for a compensation change.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Package_Reference  Compensation_PackageObject  [0..1]  Compensation Package to assign.   
Compensation_Grade_Reference  Compensation_GradeObject  [0..1]  Compensation grade to assign. Required if you select a compensation package. Doesn't default for Request Compensation Change.   
Compensation_Grade_Profile_Reference  Compensation_Grade_ProfileObject  [0..1]  Profile within the Compensation Grade to assign. Does not default for Request Compensation Change.   
Compensation_Step_Reference  Compensation_StepObject  [0..1]  Compensation Step within the Compensation Grade Profile.   
Progression_Start_Date  date  [0..1]  Start date for the Compensation Step.   
Validation Description
Compensation grade profile is not valid for the compensation grade.  Compensation grade profile is not valid for the compensation grade. 
Compensation step is not valid for the compensation grade profile.  Compensation step is not valid for the compensation grade profile. 
Compensation Grade is required.  Compensation Grade is required. 
Compensation step is not valid for the compensation grade.  Compensation step is not valid for the compensation grade. 
Compensation package is required.  Compensation package is required. 
top
 

Compensation_PackageObject

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

Compensation_PackageObjectID

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

Compensation_GradeObject

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

Compensation_GradeObjectID

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

Compensation_Grade_ProfileObject

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

Compensation_Grade_ProfileObjectID

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

Compensation_StepObject

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

Compensation_StepObjectID

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

Proposed_Base_Pay_Plan_Job_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Salary or Hourly Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Pay_Plan_Sub_Data  Proposed_Base_Pay_Plan_Job_Assignment_Data  [0..*]  Encapsulating element containing all Salary or Hourly Plan Compensation data.   
top
 

Proposed_Base_Pay_Plan_Job_Assignment_Data

part of: Proposed_Base_Pay_Plan_Job_Assignment_Container_Data
Encapsulating element containing all Salary or Hourly Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Pay_Plan_Reference  Salary_Pay_PlanObject  [0..1]  Salary or hourly plan to update or assign. Doesn't default for Request Compensation Change.   
Amount  decimal (26, 6)   [1..1]  Amount for the salary or hourly plan assignment. Required if the plan has no default amount. Decimal precision of the amount must match the currency. Mutually exclusive from the percent. 
Validation Description
The amount entered must be greater than or equal to the minimum wage amount for plan [plan].   
 
Currency_Reference  CurrencyObject  [1..1]  Currency of the plan assignment.   
Frequency_Reference  FrequencyObject  [1..1]  Frequency of the salary or hourly plan. Required if the plan has no default frequency.   
Expected_End_Date  date  [0..1]  Expected end date for the plan assignment.   
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Expected End Date.   
 
top
 

Salary_Pay_PlanObject

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

Salary_Pay_PlanObjectID

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

CurrencyObject

part of: One-Time_Payment_Data, Proposed_Salary_Unit_Plan_Assignment_Data, Proposed_Allowance_Plan_Assignment_Data, Proposed_Allowance_Unit_Plan_Assignment_Data, Proposed_Commission_Plan_Assignment_Data, Individual_Stock_Grant_Data, Individual_Stock_Grant_Data, Proposed_Base_Pay_Plan_Job_Assignment_Data, Proposed_Stock_Plan_Assignment_Data, Proposed_Period_Salary_Plan_Assignment_Data, Proposed_Calculated_Plan_Assignment_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  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

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

Proposed_Salary_Unit_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Unit Salary Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Unit_Salary_Plan_Sub_Data  Proposed_Salary_Unit_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Unit Salary Plan Compensation data. 
Validation Description
Salary Unit Plan Per Unit Amount has to be greater than zero, If you do not wish to use Salary Unit Plan, leave the field blank.   
 
top
 

Proposed_Salary_Unit_Plan_Assignment_Data

part of: Proposed_Salary_Unit_Plan_Assignment_Container_Data
Encapsulating element containing all Unit Salary Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Unit_Salary_Plan_Reference  Salary_Unit_PlanObject  [0..1]  Unit salary plan to update or assign. Doesn't default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Per_Unit_Amount  decimal (26, 6)   [0..1]  Amount per unit of the unit salary plan. Decimal precision of the amount must match the currency. Required if there is no default amount for the plan. 
Validation Description
[plan] requires Per Unit Amount and system was unable to default from plan.   
Plan [plan] does not allow for individual overrides.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the unit amount. Required if there is no default currency for the plan. 
Validation Description
Currency is required due to an amount entered or is required for plan [plan] and system was unable to default from the plan.   
Plan [plan] does not allow for individual overrides.   
 
Default_Units  decimal (21, 6) >0   [0..1]  Number of units to assign. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the unit salary plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Validation Description
Salary Unit Plan Per Unit Amount has to be greater than zero, If you do not wish to use Salary Unit Plan, leave the field blank.   
top
 

Salary_Unit_PlanObject

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

Salary_Unit_PlanObjectID

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

Proposed_Allowance_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Allowance Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Allowance_Plan_Sub_Data  Proposed_Allowance_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Allowance Plan Compensation data. 
Validation Description
Amount has to be greater than zero, if you do not wish to use Amount, leave the field blank   
Manage by Compensation Basis Override Amount for Proposed Allowance Plan, has to be greater than zero. If you do not wish to use Manage by Compensation Basis Override Amount, leave the field blank.   
 
top
 

Proposed_Allowance_Plan_Assignment_Data

part of: Proposed_Allowance_Plan_Assignment_Container_Data
Encapsulating element containing all Allowance Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Allowance_Plan_Reference  Allowance_Value_PlanObject  [0..1]  Allowance Plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Percent [Choice]   decimal (20, 10) >0   [0..1]  Percent for the allowance plan. Required if percent allowance plan is entered and there is no default percent for the plan. The amount will be calculated using this percent. Mutually exclusive from the amount. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Amount [Choice]   decimal (26, 6)   [0..1]  Amount for the allowance plan. Decimal precision of the amount must match the currency. Required if amount allowance plan is entered and there is no default amount for the plan. Mutually exclusive from the percent. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not valid for plan [plan] because the plan is not a percent based plan.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the allowance plan. Required if amount allowance plan is entered and there is no default currency for the plan. 
Validation Description
Currency Reference for plan [plan] must be [currency] to match the currency of the worker's proposed pay range.   
Plan [plan] does not allow for individual overrides.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Currency Reference.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the allowance plan. Required if there is no default frequency for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Frequency Reference.   
 
Expected_End_Date  date  [0..1]  Expected end date for the plan assignment.   
Reimbursement_Start_Date  date  [0..1]  Reimbursement Start Date. 
Validation Description
Reimbursement Start Date must be entered for reimbursable allowance plans that use an expense accumulator requiring a custom date. For all other allowance plans it must be empty.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Expected End Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met. 
Validation Description
Fixed for Manage by Compensation Basis is not a valid field for percent based plan [plan].   
 
Validation Description
Amount has to be greater than zero, if you do not wish to use Amount, leave the field blank   
Manage by Compensation Basis Override Amount for Proposed Allowance Plan, has to be greater than zero. If you do not wish to use Manage by Compensation Basis Override Amount, leave the field blank.   
top
 

Allowance_Value_PlanObject

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

Allowance_Value_PlanObjectID

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

Proposed_Allowance_Unit_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Unit Allowance Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Unit_Allowance_Plan_Sub_Data  Proposed_Allowance_Unit_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Unit Allowance Plan Compensation data. 
Validation Description
Number of Units amount has to be greater than zero. If you do no wish to use Number of Units, leave the field blank.   
 
top
 

Proposed_Allowance_Unit_Plan_Assignment_Data

part of: Proposed_Allowance_Unit_Plan_Assignment_Container_Data
Encapsulating element containing all Unit Allowance Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Unit_Allowance_Plan_Reference  Allowance_Unit_PlanObject  [0..1]  Unit Allowance Plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Number_of_Units  decimal (21, 6) >0   [0..1]  Number of units to assign. Required if there is no default number of units for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the unit allowance plan. Required if there is no default frequency for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Per_Unit_Amount  decimal (26, 6)   [0..1]  Amount per unit of the unit allowance plan. Required if there is no default amount per unit for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the unit amount. Required if there is no default currency for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Reimbursement_Start_Date  date  [0..1]  Reimbursement Start Date. 
Validation Description
Reimbursement Start Date must be entered for reimbursable allowance plans that use an expense accumulator requiring a custom date. For all other allowance plans it must be empty.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met.   
Validation Description
Number of Units amount has to be greater than zero. If you do no wish to use Number of Units, leave the field blank.   
top
 

Allowance_Unit_PlanObject

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

Allowance_Unit_PlanObjectID

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

Proposed_Bonus_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Bonus Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Bonus_Plan_Sub_Data  Proposed_Bonus_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Bonus Plan Compensation data.   
top
 

Proposed_Bonus_Plan_Assignment_Data

part of: Proposed_Bonus_Plan_Assignment_Container_Data
Encapsulating element containing all Bonus Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Bonus_Plan_Reference  Bonus_PlanObject  [0..1]  Bonus Plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Individual_Target_Amount [Choice]   decimal (26, 6)   [0..1]  Individual target amount that overrides the default target percent on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Percent. 
Validation Description
Amount cannot be entered for plan [plan] which is a percent based plan.   
Plan [plan] does not allow for individual overrides.   
 
Individual_Target_Percent [Choice]   decimal (16, 6) >0   [0..1]  Individual target percent that overrides the default target percent on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Amount. 
Validation Description
Percent cannot be entered for plan [plan] which is an amount based plan.   
Plan [plan] does not allow for individual overrides.   
 
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not valid for plan [plan] because the plan is not a percent based plan.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Guaranteed_Minimum  boolean  [0..1]  If true, employee is guaranteed the minimum for the bonus plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Percent_Assigned  decimal (16, 6) >0   [0..1]  Percent of the bonus assigned. If none entered, default is 100%.   
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met. 
Validation Description
Fixed for Manage by Compensation Basis is not a valid field for percent based plan [plan].   
 
top
 

Bonus_PlanObject

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

Bonus_PlanObjectID

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

Proposed_Merit_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Merit Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Merit_Plan_Sub_Data  Proposed_Merit_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Merit Plan Compensation data.   
top
 

Proposed_Merit_Plan_Assignment_Data

part of: Proposed_Merit_Plan_Assignment_Container_Data
Encapsulating element containing all Merit Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Merit_Plan_Reference  Merit_PlanObject  [0..1]  Merit Plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Individual_Target_Amount  decimal (26, 6)   [0..1]  Individual target amount that overrides the default target amount on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Percent. 
Validation Description
Amount cannot be entered for plan [plan] which is a percent based plan.   
Plan [plan] does not allow for individual overrides.   
 
Individual_Target_Percent  decimal (16, 6) >0   [0..1]  Individual target percent that overrides the default target percent on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Amount. 
Validation Description
Percent cannot be entered for plan [plan] which is an amount based plan.   
Plan [plan] does not allow for individual overrides.   
 
Guaranteed_Minimum  boolean  [0..1]  If true, employee is guaranteed the minimum for the merit plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
 
top
 

Merit_PlanObject

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

Merit_PlanObjectID

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

Proposed_Commission_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Commission Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Commission_Plan_Sub_Data  Proposed_Commission_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Commission Plan Compensation data. 
Validation Description
Target Amount has to be greater than zero. If you do not wish to use Target Amount, leave the field blank.   
 
top
 

Proposed_Commission_Plan_Assignment_Data

part of: Proposed_Commission_Plan_Assignment_Container_Data
Encapsulating element containing all Commission Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Commission_Plan_Reference  Commission_PlanObject  [0..1]  Commission plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Target_Amount  decimal (26, 6)   [0..1]  Target amount for the Commission Plan.   
Currency_Reference  CurrencyObject  [0..1]  Currency for the Commission Plan. Required if the target amount is entered and there is no default currency for the plan.   
Frequency_Reference  FrequencyObject  [0..1]  Frequency for the Commission Plan. Required if the target amount is entered and there is no default amount for the plan.   
Draw_Amount  decimal (21, 6) >0   [0..1]  Draw amount for the Commission Plan.   
Draw_Frequency_Reference  FrequencyObject  [0..1]  Reference element representing a unique instance of Frequency for the Draw Amount.   
Draw_Duration  string  [0..1]  Description of the duration of the draw amount. For informational purposes.   
Recoverable  boolean  [0..1]  If true, the compensation element is recoverable.   
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met.   
Validation Description
Target Amount has to be greater than zero. If you do not wish to use Target Amount, leave the field blank.   
top
 

Commission_PlanObject

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

Commission_PlanObjectID

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

Proposed_Stock_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Stock Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Stock_Plan_Sub_Data  Proposed_Stock_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Stock Plan Compensation data.   
top
 

Proposed_Stock_Plan_Assignment_Data

part of: Proposed_Stock_Plan_Assignment_Container_Data
Encapsulating element containing all Stock Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Stock_Plan_Reference  Stock_PlanObject  [0..1]  Stock plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Individual_Target_Shares [Choice]   decimal (21, 6) >0   [0..1]  Individual target shares that overrides the default target shares on the plan, provided Allow Target Override is enabled on the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.  Stock Plan does not allow override for individual target. 
Individual Target Shares is only valid if Stock Plan is unit based.   
 
Individual_Target_Percent [Choice]   decimal (18, 6) >0   [0..1]  Individual target percent that overrides the default target amount on the plan, provided Allow Target Override is enabled on the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.  Stock Plan does not allow override for individual target. 
Individual Target Percent is only valid if Stock Plan is percent based.   
 
Individual_Target_Amount [Choice]   decimal (26, 6)   [0..1]  Individual target amount that overrides the default target amount on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Percent. 
Validation Description
Plan [plan] does not allow for individual overrides.  Stock Plan does not allow override for individual target. 
Individual Target Amount is only valid if Stock Plan is an amount based.   
 
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not valid for plan [plan] because the plan is not a percent based plan.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the stock plan assignment. Only applicable for stock amount plans. 
Validation Description
Currency Reference is required when specifying an Individual Target Amount.   
Currency Reference for plan [plan] must be [currency] to match the currency of the worker's proposed pay range.   
Currency Reference must match the currency used by the referenced stock plan ([stock plan name]): [currency].   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Currency Reference.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met. 
Validation Description
Fixed for Manage by Compensation Basis is not a valid field for stock plan [plan] because it is not an amount based plan.   
 
top
 

Stock_PlanObject

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

Stock_PlanObjectID

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

Proposed_Period_Salary_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Period Salary Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Period_Salary_Plan_Sub_Data  Proposed_Period_Salary_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Period Salary Plan Compensation data. 
Validation Description
Manage by Compensation Basis Override Amount for Proposed Period Salary has to be greater than zero. If you do not wish to use Manage by Compensation Basis Override Amount, leave the field blank.   
 
top
 

Proposed_Period_Salary_Plan_Assignment_Data

part of: Proposed_Period_Salary_Plan_Assignment_Container_Data
Encapsulating element containing all Period Salary Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Period_Salary_Plan_Reference  Period_Salary_PlanObject  [0..1]  Period salary plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Compensation_Period_Reference  Compensation_PeriodObject  [0..1]  Compensation period of time measure.   
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the period salary plan. 
Validation Description
Currency Reference for plan [plan] must be [currency] to match the currency of the worker's proposed pay range.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Currency Reference.   
 
Compensation_Period_Multiplier  decimal (18, 6) >0   [0..1]  Default Compensation Period Multiplier is required.   
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the period salary plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Frequency Reference.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Validation Description
Manage by Compensation Basis Override Amount for Proposed Period Salary has to be greater than zero. If you do not wish to use Manage by Compensation Basis Override Amount, leave the field blank.   
top
 

Period_Salary_PlanObject

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

Period_Salary_PlanObjectID

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

Compensation_PeriodObject

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

Compensation_PeriodObjectID

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

Proposed_Calculated_Plan_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_Data
Encapsulating element containing all Calculated Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Calculated_Plan_Sub_Data  Proposed_Calculated_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Calculated Plan Compensation data. 
Validation Description
Manage By Compensation Basis Override Amount for Proposed Calculated Plan has to be greater than zero. If you do not wish to use Manage By Compensation Basis Override Amount, leave the field blank.   
 
top
 

Proposed_Calculated_Plan_Assignment_Data

part of: Proposed_Calculated_Plan_Assignment_Container_Data
Encapsulating element containing all Calculated Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Calculated_Plan_Reference  Calculated_PlanObject  [0..1]  Calculated plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the calculated plan. 
Validation Description
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Currency Reference.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the calculated plan. 
Validation Description
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Frequency Reference.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
 
Validation Description
Manage By Compensation Basis Override Amount for Proposed Calculated Plan has to be greater than zero. If you do not wish to use Manage By Compensation Basis Override Amount, leave the field blank.   
top
 

Calculated_PlanObject

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

Calculated_PlanObjectID

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

Update_ID_Information_Sub_Business_Process

part of: Hire_Employee_Business_Process_Data
The main element for the Change ID Business Process. This contains all the ID information and Business Processing processing parameters