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 Replac