Service Directory > v32.1 > Staffing > Contract_Contingent_Worker
 

Operation: Contract_Contingent_Worker

Contracts an existing pre-hire into a contingent worker position or job. Uses the Contract Contingent Worker 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: Contract_Contingent_Worker_Request

This web service operation is designed to contract an existing applicant into an existing Position or Job Group.
 
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.   
Contract_Contingent_Worker_Data  Contract_Contingent_Worker_Business_Process_Data  [1..1]  Wrapper element for the Contract Contingent Worker business process web service and its sub business processes. 
Validation Description
There are no hiring restrictions for the supervisory organization [org] as of the contract start date [date].   
There are no available openings in the supervisory organization [org].  Verify that there is an opening in the organization that is not restricted to employees only or has an earliest hire date that is not greater than the contract start date. 
The applicant [applicant] is not available to be contracted. Verify the hire eligibility for the applicant.   
The applicant [app] has already been hired.   
The [pg] [hg] is either not in the organization [org] or it is not fillable.  Verify that the position specified is in the organization selected and that it allows contingent workers. 
The opening [hg] [pg] or the organization [org] is restricted to employees only.   
The organization [org] does not have any fillable openings. Verify that the contracting information will meet the restrictions and availability date for the organization.   
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. 
Start date cannot be earlier than the earliest hire date [date] for the position group.   
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.   
You can’t hire someone who was purged. Create a new pre-hire.   
 
top
 

Response Element: Contract_Contingent_Worker_Response

Responds with the event id of the contract contingent worker 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 contract contingent worker event.   
Contingent_Worker_Reference  WorkerObject  [0..1]  Reference to Contingent Worker if web service was automatically completed.   
Position_Reference  Position_ElementObject  [0..1]  Reference to position if web service was automatically completed.   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Business_Process_Parameters

part of: Contract_Contingent_Worker_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
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, Contract_Contingent_Worker_Response, Purchase_Order_Contract_Details_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
 

Contract_Contingent_Worker_Business_Process_Data

part of: Contract_Contingent_Worker_Request
Wrapper element for the Contract Contingent Worker business process web service and its sub business processes.
 
Parameter name Type/Value Cardinality Description Validations
Applicant_Reference [Choice]   ApplicantObject  [1..1]  Reference to the applicant that will become a contingent worker. The applicant must exist in the system and be eligible for hire.   
Former_Worker_Reference [Choice]   Former_WorkerObject  [1..1]  Reference to a Former Worker that will be contracted. Choose either an Applicant, Former Worker or Applicant Data (to create a new applicant). Former Workers are special persons who were added during implementation to the former worker store. 
Validation Description
Verify that this former worker is eligible for hire.   
 
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]  Reference to the supervisory organization the contingent worker will be contracted into. This can be derived from the Position Reference if one of those is entered. For Job Management organizations, it must be supplied. 
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]  Reference to the Position Management group to contract the worker into. This must be an existing position group that is for the supervisory organization. Leave blank if the worker is being contracted into a Headcount Group or a supervisory organization using the Job Management staffing policy. 
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. 
When Job Requisition is enabled, you're not allowed to select a position without an open job requisition.   
 
Job_Requisition_Reference [Choice]   Job_RequisitionObject  [0..1]  Job requisition reference for the position to move the worker into. 
Validation Description
There is no available position for the job requisition.   
The job requisition must be for a contingent worker.   
 
Contract_Start_Date  date  [1..1]  The date the contract takes effect. 
Validation Description
The effective date ([a]) must be on or after the recruiting start date ([b]).   
Select a Contract Start Date that is after [term_date], the applicant's last day of work.   
 
Contract_Contingent_Worker_Event_Data  Contract_Contingent_Worker_Event_Data  [1..1]  Wrapper element for the details of a contingent worker contract. 
Validation Description
First day of work cannot be earlier than contract start date.   
Contract end date cannot be earlier than contract start date.   
Contract Details Data element is required if Create Purchase Order is true.   
The Contingent Worker ID submitted is already in use by a person [CW] who is not the Applicant.   
Select a supplier that is active or on hold to create the purchase order.   
Enter a supplier that isn't a basic worktag in the Supplier Reference field.   
 
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.   
 
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.   
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. 
 
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.   
Validation Description
There are no hiring restrictions for the supervisory organization [org] as of the contract start date [date].   
There are no available openings in the supervisory organization [org].  Verify that there is an opening in the organization that is not restricted to employees only or has an earliest hire date that is not greater than the contract start date. 
The applicant [applicant] is not available to be contracted. Verify the hire eligibility for the applicant.   
The applicant [app] has already been hired.   
The [pg] [hg] is either not in the organization [org] or it is not fillable.  Verify that the position specified is in the organization selected and that it allows contingent workers. 
The opening [hg] [pg] or the organization [org] is restricted to employees only.   
The organization [org] does not have any fillable openings. Verify that the contracting information will meet the restrictions and availability date for the organization.   
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. 
Start date cannot be earlier than the earliest hire date [date] for the position group.   
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.   
You can’t hire someone who was purged. Create a new pre-hire.   
top
 

ApplicantObject

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

Create_Applicant_Data

part of: Contract_Contingent_Worker_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. 
Primary address on Ship-To location must have a use of [Shipping]  Primary address on Ship-To location must have a use of that maps to Shipping. 
 
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
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
 
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
 
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
 
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
 
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
 
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
 
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
 
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
 
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
 
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: Person_Disability_Status_Data, 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
 
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
 
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
 
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
 
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
 
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
 
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
 
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
 
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
 
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
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, Contract_Contingent_Worker_Response, Notification_Sub_Type_Configuration
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

National_ID_Data

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

National_ID_TypeObject

part of: National_ID_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  National_ID_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

National_ID_TypeObjectID

part of: National_ID_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, National_ID_Type_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

National_Identifier_ReferenceObject

part of: National_ID
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  National_Identifier_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

National_Identifier_ReferenceObjectID

part of: National_Identifier_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, National_Identifier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Government_ID

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

Government_ID_Data

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

Government_ID_Type__All_Object

part of: Government_ID_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Government_ID_Type__All_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Government_ID_Type__All_ObjectID

part of: Government_ID_Type__All_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Government_ID_Type_ID, I9_Government_Identifier_Type_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Government_Identifier_ReferenceObject

part of: Government_ID
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Government_Identifier_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Government_Identifier_ReferenceObjectID

part of: Government_Identifier_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Government_Identifier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Visa_ID

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

Visa_ID_Data

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

Visa_ID_TypeObject

part of: Visa_ID_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Visa_ID_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Visa_ID_TypeObjectID

part of: Visa_ID_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Visa_ID_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Visa_Identifier_ReferenceObject

part of: Visa_ID
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Visa_Identifier_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Visa_Identifier_ReferenceObjectID

part of: Visa_Identifier_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Visa_Identifier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Passport_ID

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

Passport_ID_Data

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

Passport_ID_Type__All_Object

part of: Passport_ID_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Passport_ID_Type__All_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Passport_ID_Type__All_ObjectID

part of: Passport_ID_Type__All_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, I9_Passport_Identifier_Type_Code, Passport_ID_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Passport_Identifier_ReferenceObject

part of: Passport_ID
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Passport_Identifier_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Passport_Identifier_ReferenceObjectID

part of: Passport_Identifier_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Passport_Identifier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

License_ID

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

License_IdentifierObject

part of: License_ID
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  License_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

License_IdentifierObjectID

part of: License_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, License_Identifier_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

License_ID_Data

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

License_ID_Type__All_Object

part of: License_ID_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  License_ID_Type__All_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

License_ID_Type__All_ObjectID

part of: License_ID_Type__All_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, I9_License_Identifier_Type_Code, License_ID_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

AuthorityObject

part of: License_ID_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

AuthorityObjectID

part of: AuthorityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Authority_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

License_Identifier_ReferenceObject

part of: License_ID
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  License_Identifier_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

License_Identifier_ReferenceObjectID

part of: License_Identifier_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, License_Identifier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Custom_ID

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

Custom_ID_Data

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

Custom_ID_TypeObject

part of: Custom_ID_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Custom_ID_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_ID_TypeObjectID

part of: Custom_ID_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_ID_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

OrganizationObject

part of: Custom_ID_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Custom_Identifier_ReferenceObject

part of: Custom_ID
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Custom_Identifier_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Identifier_ReferenceObjectID

part of: Custom_Identifier_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Identifier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Contact_Information_Data

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

Address_Information_Data

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

Address_Line_Information_Data

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

Submunicipality_Information_Data

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

Subregion_Information_Data

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

Communication_Method_Usage_Information_Data

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

Communication_Usage_Type_Data

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

Communication_Usage_TypeObject

part of: Communication_Usage_Type_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Communication_Usage_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Communication_Usage_TypeObjectID

part of: Communication_Usage_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Communication_Usage_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Communication_Usage_BehaviorObject

part of: Communication_Method_Usage_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Communication_Usage_BehaviorObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Communication_Usage_BehaviorObjectID

part of: Communication_Usage_BehaviorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Communication_Usage_Behavior_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Communication_Usage_Behavior_TenantedObject

part of: Communication_Method_Usage_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Communication_Usage_Behavior_TenantedObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Communication_Usage_Behavior_TenantedObjectID

part of: Communication_Usage_Behavior_TenantedObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Communication_Usage_Behavior_Tenanted_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Address_ReferenceObject

part of: Address_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Address_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Address_ReferenceObjectID

part of: Address_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Address_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Phone_Information_Data

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

Phone_Device_TypeObject

part of: Phone_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Phone_Device_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Phone_Device_TypeObjectID

part of: Phone_Device_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Phone_Device_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Phone_ReferenceObject

part of: Phone_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Phone_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Phone_ReferenceObjectID

part of: Phone_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Phone_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Email_Address_Information_Data

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

Email_ReferenceObject

part of: Email_Address_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Email_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Email_ReferenceObjectID

part of: Email_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Email_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Instant_Messenger_Information_Data

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

Instant_Messenger_TypeObject

part of: Instant_Messenger_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Instant_Messenger_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Instant_Messenger_TypeObjectID

part of: Instant_Messenger_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Instant_Messenger_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Instant_Messenger_ReferenceObject

part of: Instant_Messenger_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Instant_Messenger_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Instant_Messenger_ReferenceObjectID

part of: Instant_Messenger_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Instant_Messenger_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Web_Address_Information_Data

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

Web_Address_ReferenceObject

part of: Web_Address_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Web_Address_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Web_Address_ReferenceObjectID

part of: Web_Address_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Web_Address_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Political_AffiliationObject

part of: Personal_Information_Data, Change_Personal_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Political_AffiliationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Political_AffiliationObjectID

part of: Political_AffiliationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Political_Affiliation_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Social_Benefits_LocalityObject

part of: Personal_Information_Data, Change_Personal_Information_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Social_Benefits_LocalityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Social_Benefits_LocalityObjectID

part of: Social_Benefits_LocalityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Social_Benefits_Locality_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Relative_Name_Information_Data

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

Relative_Name_Data

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

Relative_Name_ReferenceObject

part of: Relative_Name_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Relative_Name_ReferenceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Relative_Name_ReferenceObjectID

part of: Relative_Name_ReferenceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Relative_Name_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Relative_TypeObject

part of: Relative_Name_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Relative_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Relative_TypeObjectID

part of: Relative_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Relative_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

External_Integration_ID_Data

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

ID

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

Supervisory_OrganizationObject

part of: Contract_Contingent_Worker_Business_Process_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Supervisory_OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supervisory_OrganizationObjectID

part of: Supervisory_OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Position_RestrictionsObject

part of: Contract_Contingent_Worker_Business_Process_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Position_RestrictionsObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Position_RestrictionsObjectID

part of: Position_RestrictionsObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Position_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Job_RequisitionObject

part of: Contract_Contingent_Worker_Business_Process_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Job_RequisitionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Job_RequisitionObjectID

part of: Job_RequisitionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Job_Requisition_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Contract_Contingent_Worker_Event_Data

part of: Contract_Contingent_Worker_Business_Process_Data
Wrapper element for the details of a contingent worker contract.
 
Parameter name Type/Value Cardinality Description Validations
Contingent_Worker_ID  string  [0..1]  If this is a rehire, you can leave the ID blank and the Contingent Worker ID that is currently used for the terminated contingent worker instance will be used. You can also enter a new ID to be used (which will change the ID on the terminated contingent worker instance). If this is a new contingent worker and you are using an contingent worker id sequence generator, leave this ID blank and the next ID in the sequence will be given to the contingent worker . If this is a new contingent worker and you are not using an contingent worker id sequence generator, enter the ID you want to use. If you leave it blank, an unique ID will be generated. If this is a former worker and Reuse Former Worker ID tenant setup is on, leave this ID blank and the ID from the former worker will be defaulted in if it is not already in use by another employee.   
Position_ID  string  [0..1]  If you are contracting the worker into a Position Group, you should not submit this field. The existing Position ID will continue to be used. If the worker is being contracted into a Headcount Group or Job Management Organization, then a new "position" will be created for them. You can choose to enter an unique ID of your own choosing. If you do not submit it, an unique ID will be generated for it - either using the Position ID sequence generator if you have set one up - or another system generated ID will be used. This is the ID that you will be able to use in later web services where a Position Reference is needed. 
Validation Description
Do not enter a Position ID when hiring, contracting or transferring into a Position Management position. The position already has an ID.   
Position ID [id] is already in use by another position [position].   
 
Contract_Worker_Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Reference to the reason the worker is being contracted.   
Contract_Worker_Type_Reference  Contingent_Worker_TypeObject  [0..1]  Reference to the type of contingent worker. 
Validation Description
Please make sure you enter a valid Contingent Worker Type that matches with the hiring restrictions.   
Contingent Worker Type is required if the worker is a contingent worker.   
Contingent Worker Type is not valid for the Job Requisition.   
 
Create_Purchase_Order  boolean  [0..1]  Set the Create Purchase Order to True if you use Workday Procurement and you wish a purchase order to be created for this contingent worker. Setting the flag to True will cause the sub process of Create Purchase Order for Contingent Worker to be initiated after the contingent worker is created. The sub process will only be initiated if it is defined as part of the supervisory organization's business process definition. It will need to be finished online manually to activate the Purchase Order. Setting the flag to true will cause the Contract End Date to be required, and will require a currency and frequency (of an hourly type) if a pay rate is entered.   
Contract_End_Date  date  [0..1]  Date the contract is expected to end. 
Validation Description
The Contract End Date is required if Create Purchase Order is true.   
 
First_Day_of_Work  date  [0..1]  The date of the contingent worker's first day of work. If left empty, Workday uses the Contract Start Date.   
Conversion_Position_Start_Date  date  [0..1]  The employee's start date for the current position. Must be later than the Hire Date. Use only for loading existing workers during implementation. Used for Manager History and Time in Position calculations. 
Validation Description
Conversion Position Start Date cannot be earlier than the Start Date.   
 
Supplier_Reference  SupplierObject  [0..1]  If the worker is not an independent contingent worker, enter the reference to the supplier.   
Default_Payment_Term_Reference  Payment_TermsObject  [0..1]  If the worker is not an independent contract, enter the payment terms for the supplier. This attribute is not valid if supplier is not also entered. 
Validation Description
The payment terms are required because the create purchase order flag is set.   
 
Position_Details  Position_Details_Sub_Data  [1..1]  Wrapper element for filled position data. 
Validation Description
The job profile requires this position to have a work shift but none has been submitted.  The job profile requires this position to have a work shift but none has been submitted. 
Work shift is not valid for the location [location].  Work shift is not valid for the location. 
A Work Hours Profile is required for the position.  A Work Hours Profile is required for the position. 
Work Hours Profile is not valid for the Job Profile that was entered.  Work Hours Profile is not valid for the Job Profile that was entered. 
Pay Rate type cannot be entered for contingent workers.  Pay Rate type cannot be entered for contingent workers. 
When HCM tenant setup does not have Higher Education configured, you are not allowed to populate annual work period and disbursement plan period for the position.  When HCM tenant setup does not have Higher Education configured, you are not allowed to populate annual work period and disbursement plan period for the position. 
The job profile for the position is not within a job family that is configured for academic pay. You are not allowed to populate annual work period and disbursement plan period.  The job profile for the position is not within a job family that is configured for academic pay. You are not allowed to populate annual work period and disbursement plan period. 
If you select or enter a value for one of the fields in Working Time, you must complete all the fields in the grouping.   
Working Time fields are not enabled for the country associated with the position   
The Working Time field submitted cannot be entered for contingent workers   
 
Contract_Details_Data  Contract_Details_Sub_Data  [0..*]  Wrapper element for contingent worker contract details for a filled position. Only use for contingent workers. If the element is not sent, the existing contract detail data will be kept. 
Validation Description
Contract Details can only be entered for contingent worker positions.  Contract Details can only be entered for contingent worker positions. 
 
Purchase_Order_Contract_Details_Data  Purchase_Order_Contract_Details_Data  [0..1]  This element is used to group all data needed to create a purchase order if purchase orders are used. 
Validation Description
The Supplier isn't valid for the company. Enter a valid company and supplier combination.   
 
Contingent_Worker_External_ID_Data  External_ID_Data  [0..1]  Integration ID Help Text   
Validation Description
First day of work cannot be earlier than contract start date.   
Contract end date cannot be earlier than contract start date.   
Contract Details Data element is required if Create Purchase Order is true.   
The Contingent Worker ID submitted is already in use by a person [CW] who is not the Applicant.   
Select a supplier that is active or on hold to create the purchase order.   
Enter a supplier that isn't a basic worktag in the Supplier Reference field.   
top
 

Event_Classification_SubcategoryObject

part of: Contract_Contingent_Worker_Event_Data, Remove_Retiree_Status_Sub_Process_Details
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Event_Classification_SubcategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Event_Classification_SubcategoryObjectID

part of: Event_Classification_SubcategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Benefits_Event_Subcategory_ID, Change_Job_Subcategory_ID, End_Additional_Job_Subcategory_ID, Event_Classification_Subcategory_ID, General_Event_Subcategory_ID, Leave_of_Absence_Type_ID, Termination_Subcategory_ID, Undo_Move_Subcategory_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Contingent_Worker_TypeObject

part of: Contract_Contingent_Worker_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Contingent_Worker_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Contingent_Worker_TypeObjectID

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

SupplierObject

part of: Contract_Contingent_Worker_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  SupplierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

SupplierObjectID

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

Payment_TermsObject

part of: Contract_Contingent_Worker_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Payment_TermsObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_TermsObjectID

part of: Payment_TermsObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Terms_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Position_Details_Sub_Data

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

Job_ProfileObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Job_ProfileObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Job_ProfileObjectID

part of: Job_ProfileObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Job_Profile_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

LocationObject

part of: Position_Details_Sub_Data, Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Position_Time_TypeObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Position_Time_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Position_Time_TypeObjectID

part of: Position_Time_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Position_Time_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Work_ShiftObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Work_ShiftObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Work_ShiftObjectID

part of: Work_ShiftObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Work_Shift_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Work_Hours_ProfileObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Work_Hours_ProfileObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Work_Hours_ProfileObjectID

part of: Work_Hours_ProfileObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Work_Hours_Profile_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

FrequencyObject

part of: Contract_Details_Sub_Data, Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  FrequencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

FrequencyObjectID

part of: FrequencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Frequency_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Working_Time_UnitObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Working_Time_UnitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Working_Time_UnitObjectID

part of: Working_Time_UnitObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Working_Time_Unit_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Pay_Rate_TypeObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Pay_Rate_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Pay_Rate_TypeObjectID

part of: Pay_Rate_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Pay_Rate_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Job_ClassificationObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Job_ClassificationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Job_ClassificationObjectID

part of: Job_ClassificationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Job_Classification_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Company_Insider_TypeObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Company_Insider_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Company_Insider_TypeObjectID

part of: Company_Insider_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Insider_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Academic_Pay_PeriodObject

part of: Position_Details_Sub_Data, Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Academic_Pay_PeriodObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_Pay_PeriodObjectID

part of: Academic_Pay_PeriodObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Pay_Period_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Pay_With_Work-Study_OptionObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Pay_With_Work-Study_OptionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Pay_With_Work-Study_OptionObjectID

part of: Pay_With_Work-Study_OptionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Award_Option_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Workers_Compensation_CodeObject

part of: Position_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Workers_Compensation_CodeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Workers_Compensation_CodeObjectID

part of: Workers_Compensation_CodeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Workers_Compensation_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

External_ID_Data

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

External_ID

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

Contract_Details_Sub_Data

part of: Contract_Contingent_Worker_Event_Data
Wrapper element for contingent worker contract details for a filled position. Only use for contingent workers. If the element is not sent, the existing contract detail data will be kept.
 
Parameter name Type/Value Cardinality Description Validations
Contract_Pay_Rate  decimal (21, 6) >0   [0..1]  The Contract Pay Rate for the position. Automatically calculated based on the Compensation and Frequency values. 
Validation Description
The Contract Pay Rate cannot be set to zero because the position has a purchase order.   
A contract pay rate is required because this position has a purchase order.   
 
Currency_Reference  CurrencyObject  [0..1]  The preferred Currency for the contract pay rate. 
Validation Description
If Create Purchase Order is true, then the currency is required.   
The currency is required because this position has a purchase order.   
The currency cannot be changed because the position has a purchase order.   
The currency supplied is not valid for the supplier.   
 
Frequency_Reference  FrequencyObject  [0..1]  The frequency with which the worker is paid. Workday ignores values specified for employees. If empty, Workday will use the existing frequency. 
Validation Description
If Create Purchase Order is true, then frequency is required.   
If Create Purchase Order is true then the frequency must have an hourly behavior.   
Frequency is required because the position has a purchase order.   
Frequency must be an hourly type for positions with Purchase Orders.   
 
Contract_Assignment_Details  string  [0..1]  The Contract Assignment description. If empty, Workday will use the existing value.   
Validation Description
Contract Details can only be entered for contingent worker positions.  Contract Details can only be entered for contingent worker positions. 
top
 

CurrencyObject

part of: Contract_Details_Sub_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Purchase_Order_Contract_Details_Data

part of: Contract_Contingent_Worker_Event_Data
This element is used to group all data needed to create a purchase order if purchase orders are used.
 
Parameter name Type/Value Cardinality Description Validations
Company_for_Purchase_Order_Reference  CompanyObject  [0..1]  The company to be used on the purchase order if purchase orders are used.   
Requester_Reference  WorkerObject  [0..1]  The worker who is requesting this contract.   
Spend_Category_Reference  Spend_CategoryObject  [0..1]  The spend category that describes the purpose of this contract. 
Validation Description
The spend category is required because the create purchase order flag is set.   
 
Contract_Amount  decimal (26, 6) >0   [0..1]  The amount of the contract. 
Validation Description
The contract amount is required because the create purchase order flag is set.   
 
Worktags_Reference  Audited_Accounting_WorktagObject  [0..*]  The worktags to use for accounting for this contract.   
Validation Description
The Supplier isn't valid for the company. Enter a valid company and supplier combination.   
top
 

CompanyObject

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

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Audited_Accounting_WorktagObject

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

Audited_Accounting_WorktagObjectID

part of: Audited_Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Recipient_ID, Donor_ID, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Update_ID_Information_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
The main element for the Change ID Business Process. This contains all the ID information and Business Processing processing parameters.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Person_Identification_Data  Person_Identification_Data  [0..*]  Wrapper for Person Identification Data. Includes National Identifiers, Government Identifiers, Visa Identifiers, Passport Identifiers, License Identifiers and Custom Identifiers.   
top
 

Business_Sub_Process_Parameters

part of: Assign_Matrix_Organization_Sub_Business_Process, Edit_Assign_Position_Organization_Sub_Business_Process, Change_Personal_Information_Sub_Business_Process, Update_ID_Information_Sub_Business_Process, Create_Workday_Account_Sub_Business_Process, Edit_Service_Dates_Sub_Business_Process, Remove_Retiree_Status_Sub_Business_Process, Edit_Government_IDs_Sub_Business_Process, Edit_Passports_and_Visas_Sub_Business_Process, Edit_Licenses_Sub_Business_Process, Edit_Custom_IDs_Sub_Business_Process, Onboarding_Setup_Sub_Business_Process
Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete [Choice]   boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Skip [Choice]   boolean  [0..1]  When set to "true" or "1", the business process is automatically skipped (if it is defined as "skippable" within the business process definition).   
Business_Process_Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service.   
top
 

Edit_Government_IDs_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
The main element for the Edit Government IDs Business Process. This contains all the Government IDs information and Business Processing processing parameters.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Government_Identification_Data  Government_Identification_Data  [0..*]  Wrapper for Government Identification Data. Includes National Identifiers and Government Identifiers.   
top
 

Government_Identification_Data

part of: Edit_Government_IDs_Sub_Business_Process
Wrapper for Government Identification Data. Includes National Identifiers and Government Identifiers.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  If Replace All is set to True, a full sync is performed after you submit the web service. Set to False if you want to preserve the existing data and only add, edit, or remove specific reference ids. Note: If you leave this boolean value blank it defaults to True to preserve the existing Replace All functionality in older versions of this web service for web service users depending on the default behavior.   
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.   
 
top
 

Edit_Passports_and_Visas_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
The main element for the Edit Passports and Visas Business Process. This contains all the Passports and Visas IDs.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Passports_and_Visas_Identification_Data  Passports_and_Visas_Identification_Data  [0..*]  Wrapper for Passports and Visas Identification Data. Includes Passport Identifiers and Visa Identifiers   
top
 

Passports_and_Visas_Identification_Data

part of: Edit_Passports_and_Visas_Sub_Business_Process
Wrapper for Passports and Visas Identification Data. Includes Passport Identifiers and Visa Identifiers
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  If Replace All is set to True, a full sync is performed after you submit the web service. Set to False if you want to preserve the existing data and only add, edit, or remove specific reference ids. Note: If you leave this boolean value blank it defaults to True to preserve the existing Replace All functionality in older versions of this web service for web service users depending on the default behavior.   
Passport_ID  Passport_ID  [0..*]  Wrapper for 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].   
 
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].   
 
top
 

Edit_Licenses_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
The main element for the Edit Licenses Business Process. This contains all the License IDs and Business Processing processing parameters.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
License_Identification_Data  License_Identification_Data  [0..*]  Wrapper for License Identification Data. Includes License Identifiers.   
top
 

License_Identification_Data

part of: Edit_Licenses_Sub_Business_Process
Wrapper for License Identification Data. Includes License Identifiers.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  If Replace All is set to True, a full sync is performed after you submit the web service. Set to False if you want to preserve the existing data and only add, edit, or remove specific reference ids. Note: If you leave this boolean value blank it defaults to True to preserve the existing Replace All functionality in older versions of this web service for web service users depending on the default behavior.   
License_ID  License_ID  [0..*]  Encapsulating 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.   
 
top
 

Edit_Custom_IDs_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
The main element for the Edit Other IDs Business Process. This contains all the Custom IDs and Business Processing processing parameters.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Custom_Identification_Data  Custom_Identification_Data  [0..*]  Wrapper for Custom Identification Data. Includes Custom Identifiers.   
top
 

Custom_Identification_Data

part of: Edit_Custom_IDs_Sub_Business_Process
Wrapper for Custom Identification Data. Includes Custom Identifiers.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  If Replace All is set to True, a full sync is performed after you submit the web service. Set to False if you want to preserve the existing data and only add, edit, or remove specific reference ids. Note: If you leave this boolean value blank it defaults to True to preserve the existing Replace All functionality in older versions of this web service for web service users depending on the default behavior.   
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
 

Edit_Assign_Position_Organization_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
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.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Position_Organization_Assignments_Data  Assign_Position_Organization_Event_Data  [0..1]  Organization Assignments to a filled Position. The existing organization assignment will be retained if the element is not submitted. 
Validation Description
Each custom organization can only be entered once.   
 
Validation Description
The Position Organization Assignments Data element is required when Automatically Complete is True.   
top
 

Assign_Position_Organization_Event_Data

part of: Edit_Assign_Position_Organization_Sub_Business_Process
Wrapper element for Assign Position Organization business process.
 
Parameter name Type/Value Cardinality Description Validations
Company_Assignments_Reference  CompanyObject  [0..*]  The companies assigned to the position. If empty, Workday will use the existing assignments. 
Validation Description
The Company is required based on the position assignment details settings for the company organization type.   
The organization ([org]) is not valid to be entered because its type is not allowed for positions.   
The [org type] type is defined as unique - but multiple values were submitted.   
At least one of the organizations for the type is not allowed because of the restrictions on the Supervisory Organization and Locations. Organization Type: [orgtype] Supervisory Organization: [sup org] Location: [locations] Invalid Organization: [org] - Note: only one invalid organization is shown.   
 
Cost_Center_Assignments_Reference  Cost_CenterObject  [0..*]  The cost centers assigned to the position. If empty, Workday will use the existing assignments. 
Validation Description
The Cost Center is required based on the position assignment details settings for the organization type.   
The organization ([org]) is not valid to be entered because its type is not allowed for positions.   
The [org type] type is defined as unique - but multiple values were submitted.   
At least one of the organizations for the type is not allowed because of the restrictions on the Supervisory Organization and Locations. Organization Type: [orgtype] Supervisory Organization: [sup org] Location: [locations] Invalid Organization: [org] - Note: only one invalid organization is shown.   
[cost center by company validation]   
 
Region_Assignments_Reference  RegionObject  [0..*]  The regions assigned to the position. If empty, Workday will use the existing assignments. 
Validation Description
The Region is required based on the position assignment details settings for the organization type.   
The organization ([org]) is not valid to be entered because its type is not allowed for positions.   
The [org type] type is defined as unique - but multiple values were submitted.   
At least one of the organizations for the type is not allowed because of the restrictions on the Supervisory Organization and Locations. Organization Type: [orgtype] Supervisory Organization: [sup org] Location: [locations] Invalid Organization: [org] - Note: only one invalid organization is shown.   
 
Custom_Organization_Assignment_Data  Custom_Organization_Assignment_Data  [0..*]  Allows user to add new or delete existing custom organizations. If a new Unique custom organization is added - the prior org of that type will be deleted. (The old organization does not have to be submitted with delete flag true). If a new non-Unique custom organization is added - the existing org(s) of that type will be retained (unless they are sent with the delete flag true). Custom Organizations that are not being modified do not need to be submitted. 
Validation Description
At least one of the Custom organization types is required based on the position assignment details settings but has no entries.   
One of the Custom Organizations is not allowed because its type is not allowed for positions.   
At least one of the Custom Organization types is defined as unique but has multiple values.   
One of the custom organizations is not allowed because of the restrictions on the Supervisory Organization and Locations. Supervisory Organization: [sup org]. Locations: [locations].   
The custom organization(s) [custom org] does not exist on this worker and cannot be deleted.   
 
Fund_Assignments_Reference  FundObject  [0..*]  The funds assigned to the position. If empty, Workday will use the existing assignment. 
Validation Description
The Fund is required based on the position assignment details settings for the organization type.   
The organization ([org]) is not valid to be entered because its type is not allowed for positions.   
The [org type] type is defined as unique - but multiple values were submitted.   
At least one of the organizations for the type is not allowed because of the restrictions on the Supervisory Organization and Locations. Organization Type: [orgtype] Supervisory Organization: [sup org] Location: [locations] Invalid Organization: [org] - Note: only one invalid organization is shown.   
 
Grant_Assignments_Reference  GrantObject  [0..*]  The grants assigned to the position. If empty, Workday will use the existing assignment. 
Validation Description
The Grant is required based on the position assignment details settings for the organization type.   
The organization ([org]) is not valid to be entered because its type is not allowed for positions.   
The [org type] type is defined as unique - but multiple values were submitted.   
At least one of the organizations for the type is not allowed because of the restrictions on the Supervisory Organization and Locations. Organization Type: [orgtype] Supervisory Organization: [sup org] Location: [locations] Invalid Organization: [org] - Note: only one invalid organization is shown.   
 
Program_Assignments_Reference  ProgramObject  [0..*]  The programs assigned to the position. If empty, Workday will use the existing assignment. 
Validation Description
The Program is required based on the position assignment details settings for the organization type.   
The organization ([org]) is not valid to be entered because its type is not allowed for positions.   
The [org type] type is defined as unique - but multiple values were submitted.   
At least one of the organizations for the type is not allowed because of the restrictions on the Supervisory Organization and Locations. Organization Type: [orgtype] Supervisory Organization: [sup org] Location: [locations] Invalid Organization: [org] - Note: only one invalid organization is shown.   
 
Business_Unit_Assignments_Reference  Business_UnitObject  [0..*]  The business units assigned to the position. If empty, Workday will use the existing assignment. 
Validation Description
The Business Unit is required based on the position assignment details settings for the organization type.   
At least one of the organizations for the type ([orgtype]) is not allowed because of the restrictions on the supervisory organization [sup org]. Invalid Organization: [org] - Note: only one invalid organization is shown.   
The [org type] type is defined as unique - but multiple values were submitted.   
At least one of the organizations for the type is not allowed because of the restrictions on the Supervisory Organization and Locations. Organization Type: [orgtype] Supervisory Organization: [sup org] Location: [locations] Invalid Organization: [org] - Note: only one invalid organization is shown.   
 
Gift_Assignments_Reference  GiftObject  [0..*]  The gifts assigned to the position. If empty, Workday will use the existing assignment. 
Validation Description
The Gift is required based on the position assignment details settings for the organization type.   
The [org type] type is defined as unique - but multiple values were submitted.   
The organization ([org]) is not valid to be entered because its type is not allowed for positions.   
At least one of the organizations for the type is not allowed because of the restrictions on the Supervisory Organization and Locations. Organization Type: [orgtype] Supervisory Organization: [sup org] Location: [locations] Invalid Organization: [org] - Note: only one invalid organization is shown.   
 
Validation Description
Each custom organization can only be entered once.   
top
 

Cost_CenterObject

part of: Assign_Position_Organization_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Cost_CenterObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Cost_CenterObjectID

part of: Cost_CenterObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Cost_Center_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

RegionObject

part of: Assign_Position_Organization_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  RegionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

RegionObjectID

part of: RegionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Organization_Reference_ID, Region_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Custom_Organization_Assignment_Data

part of: Assign_Position_Organization_Event_Data
Allows user to add new or delete existing custom organizations. If a new Unique custom organization is added - the prior org of that type will be deleted. (The old organization does not have to be submitted with delete flag true). If a new non-Unique custom organization is added - the existing org(s) of that type will be retained (unless they are sent with the delete flag true). Custom Organizations that are not being modified do not need to be submitted.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Y, the existing custom organization listed in the Custom Organization Assignment column is deleted.   
Custom_Organization_Assignment_Reference  Custom_OrganizationObject  [1..1]  The unique identifier for the Custom Organization Assignment. When Delete equals Y, this custom organization assignment will be deleted. When Delete equals Y and no Custom Organization Assignment value is entered, the field will be left empty.   
top
 

Custom_OrganizationObject

part of: Custom_Organization_Assignment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Custom_OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_OrganizationObjectID

part of: Custom_OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Organization_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

FundObject

part of: Assign_Position_Organization_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  FundObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

FundObjectID

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

GrantObject

part of: Assign_Position_Organization_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  GrantObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

GrantObjectID

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

ProgramObject

part of: Assign_Position_Organization_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  ProgramObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

ProgramObjectID

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

part of: Assign_Position_Organization_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Business_UnitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Business_UnitObjectID

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

GiftObject

part of: Assign_Position_Organization_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  GiftObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

GiftObjectID

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

Create_Workday_Account_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
Wrapper to hold the business process configuration and user account details.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Wrapper element for web services sub business process parameters.   
Create_Workday_Account_Data  System_User_Data  [0..1]  Wrapper element for workday account data 
Validation Description
User Name already taken, please choose another one.  Validates that the user name provided is not already in use by another system user. 
Password is required when creating a new Workday Account.  Validates that a password is provided (or will be generated) for a new Workday account. 
Unable to Generate Random Password due to missing email address for notification.  Validates that an email address is available if the random password option is specified. 
Invalid Locale Code.  Validates that the code provided matches one of the locale codes in the Workday system. 
One-Time Passcode Exempt cannot be modified if the user is not required to use One-Time Passcode Authentication.   
One-Time Passcode Grace Period Remaining Login Count cannot be modified if the user is not required to use One-Time Passcode Authentication.   
One-Time Passcode Grace Period Enabled cannot be modified if the user is not required to use One-Time Passcode Authentication.   
One-Time Passcode Grace Period Remaining Login Count cannot be less than 0 or greater than the tenant Maximum Grace Period Login Count: [max count]   
 
Validation Description
The Create Workday Account Data element is required if Automatically Complete is True.   
top
 

System_User_Data

part of: Create_Workday_Account_Sub_Business_Process
The data necessary to create or update a user's account in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
User_Name  string  [1..1]  The user name the new user will use to sign on to Workday. 
Validation Description
The entered User Name is longer than the current tenant maximum. The tenant max is set to [max].   
 
Session_Timeout_Minutes  decimal (3, 0) >0   [0..1]  The number of minutes the user may be idle before the system requires them to re-enter their user name and password. 
Validation Description
Session Timeout Minutes must be greater than 5 and less than or equal to [max]. The default value is [default].  Validates that the timeout setting is between 5 and 720 minutes. 
Session Timeout Minutes must be greater than 5 and less than or equal to [max]. The default value is [default].   
 
Account_Disabled  boolean  [0..1]  The user is prevented from signing on to the system.   
Account_Expiration_Date  dateTime  [0..1]  The user will be prevented from signing on to the system after this date (Pacific Time).   
Account_Locked  boolean  [0..1]  The user is prevented from signing on to the system until their account is unlocked.   
Required_New_Password_At_Next_Login  boolean  [0..1]  The user will be required to change their password upon initial sign on.   
Show_User_Name_in_Browser_Window  boolean  [0..1]  The web browser title will include the user name in parenthesis.   
Display_XML_Icon_on_Reports  boolean  [0..1]  The user will be presented with an icon to view reports as an RSS feed.   
Enable_Workbox  boolean  [0..1]  The user will have the Workbox tab available in the right-side slide-out.   
Locale_Reference  LocaleObject  [0..1]  The local defines the user's language and country which will affect their experience in the Workday system.   
User_Language_Reference  User_LanguageObject  [0..1]  If set, specifies language for user. If not set, language specification taken from Locale_Reference parameter.   
Preferred_Search_Scope_Reference  Unique_IdentifierObject  [0..1]  If set, specifies the initial search category displayed to the user.   
Delegated_Authentication_Integration_System_Reference  Integration_System__Audited_Object  [0..1]  The user will be authenticated via an external system.   
Allow_Mixed-Language_Transactions  boolean  [0..1]  The user is allowed to view mixed language transactions.   
Notification_Sub_Type_Configurations  Notification_Sub_Category_Configurations_for_Users  [0..*]  Notification Type Configurations for a particular user   
Password [Choice]   string  [0..1]  The initial password the user will sign on with. 
Validation Description
The password does not meet password requirements.  Validates that the password conforms to the configured password rules. 
 
Generate_Random_Password [Choice]   boolean  [0..1]  The system should generate a random password for the user.   
Exempt_from_Delegated_Authentication  boolean  [0..1]  True when the user is exempt from Delegated Authentication, False otherwise. Set this element to true if you want the user to be exempt from delegated authentication.   
Passcode_Exempt  boolean  [0..1]  True when the user is exempt from One-Time Passcode Authentication, False otherwise. Set this element to true if you want the user to be exempt from one-time passcode authentication.   
Passcode_Grace_Period_Enabled  boolean  [0..1]  True when the user's One-Time Passcode grace period is enabled, False otherwise. Set this element to false if you want the user's one-time passcode grace period to be disabled.   
Passcode_Grace_Period_Login_Remaining_Count  decimal (12, 0)   [0..1]  The remaining number of times the user can login without providing a one-time passcode. This cannot be higher than the configured tenant maximum grace period login count.   
OpenID_Identifier  string  [0..1]  This field is used for OpenID based authentication and contains the email address associated with the OpenID account. This value needs to be provided to enable OpenID authentication for this user.   
OpenID_Internal_Identifier  string  [0..1]  This field is used for OpenID based authentication and contains the OpenID GUID. It will be unpopulated until the user completes an initial successful OpenID authentication attempt.   
OpenID_Connect_Internal_Identifier  string  [0..1]  This field is used for OpenID Connect based authentication and contains the OpenID Connect subject. It will be unpopulated until the user completes an initial successful OpenID Connect authentication attempt.   
Simplified_View  boolean  [0..1]  To enable user preferences that simplify the overall user experience.   
Validation Description
User Name already taken, please choose another one.  Validates that the user name provided is not already in use by another system user. 
Password is required when creating a new Workday Account.  Validates that a password is provided (or will be generated) for a new Workday account. 
Unable to Generate Random Password due to missing email address for notification.  Validates that an email address is available if the random password option is specified. 
Invalid Locale Code.  Validates that the code provided matches one of the locale codes in the Workday system. 
One-Time Passcode Exempt cannot be modified if the user is not required to use One-Time Passcode Authentication.   
One-Time Passcode Grace Period Remaining Login Count cannot be modified if the user is not required to use One-Time Passcode Authentication.   
One-Time Passcode Grace Period Enabled cannot be modified if the user is not required to use One-Time Passcode Authentication.   
One-Time Passcode Grace Period Remaining Login Count cannot be less than 0 or greater than the tenant Maximum Grace Period Login Count: [max count]   
top
 

LocaleObject

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

LocaleObjectID

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

User_LanguageObject

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

User_LanguageObjectID

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

Integration_System__Audited_Object

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

Integration_System__Audited_ObjectID

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

Notification_Sub_Category_Configurations_for_Users

part of: System_User_Data
Notification Type configurations for a particular user
 
Parameter name Type/Value Cardinality Description Validations
Notification_Sub_Type_Configuration  Notification_Sub_Type_Configuration  [0..*]  Notification Sub Type configuration(includes selected notification channels) for each Notification Sub Type.   
top
 

Notification_Sub_Type_Configuration

part of: Notification_Sub_Category_Configurations_for_Users
Notification sub type configuration for each notification sub type
 
Parameter name Type/Value Cardinality Description Validations
Notification_Sub_Type_Reference  Notification_CategorizableObject  [0..1]  Notification sub type for which notification channels will be updated/added. 
Validation Description
Notification Type [Notification Sub Category] must be enabled for user preferences in order to update Notification Channels   
 
Notification_channels_Reference  Unique_IdentifierObject  [0..*]  Notification channels to add/update for specified notification sub type. These Notification Channels must be allowed for the Notification Sub Type. 
Validation Description
This notification type [Notification Categorizable] contains default Notification Channels that are no longer valid.   
If Disabled is selected no other notification channels may be selected.   
 
top
 

Notification_CategorizableObject

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

Notification_CategorizableObjectID

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

Assign_Matrix_Organization_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
Encapsulates the Assign Matrix Organization sub business process.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Wrapper element for web services sub business process parameters.   
Assign_Matrix_Organization_Data  Assign_Matrix_Organization_Data  [0..1]  Contains the assignment of a matrix organization to a worker/position. 
Validation Description
A matrix organization must be entered for the Assign Matrix Organization sub business process.   
 
Validation Description
The Assign Matrix Organization Data element is required if Automatically Complete is True.   
top
 

Assign_Matrix_Organization_Data

part of: Assign_Matrix_Organization_Sub_Business_Process
Wrapper for Assign Matrix Organizations event data which is usable for the standalone business process web service and when it is used as a sub business process.
 
Parameter name Type/Value Cardinality Description Validations
Matrix_Organization_Reference  Matrix_OrganizationObject  [0..*]  Matrix organization to assign to the worker.   
Validation Description
A matrix organization must be entered for the Assign Matrix Organization sub business process.   
top
 

Matrix_OrganizationObject

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

Matrix_OrganizationObjectID

part of: Matrix_OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Change_Personal_Information_Sub_Business_Process

part of: Contract_Contingent_Worker_Business_Process_Data
Wrapper for the Change Personal data sub business process that is part of the Hire and Edit Position business processes.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Change_Personal_Information_Data  Change_Personal_Information_Data  [0..1]  Container for the data changed in the Change Personal Information business process. 
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. 
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. 
The hukou region is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The hukou region is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The hukou subregion is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The hukou subregion is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The hukou locality is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The hukou locality is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The hukou type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The hukou type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The native region is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The native region is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Personnel File Agency is not tracked for the specified Location Context.  The Personnel File Agency is not tracked for the specified Location Context. 
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. 
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 hukou postal code is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The hukou postal code is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location 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 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. 
Invalid Date of Death. It must be between today's date and the worker's hire date.  Invalid Date of Death. It must be between today's date and the worker's hire date. 
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 
The 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 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 
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 
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. 
Hispanic or Latino is only tracked in the USA and must be enabled in tenant setup by your administrator.  Hispanic or Latino is only tracked in the USA and must be enabled in tenant setup by your administrator. 
Multiple Ethnicities are not allowed for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  Multiple Ethnicities are not allowed for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
At least one citizenship status in this request is inactive. Only active statuses are allowed.  At least one citizenship status in this request is inactive. Only active statuses are allowed. 
At least one ethnicity in this request is inactive. Only active ethnicities are allowed.  At least one ethnicity in this request is inactive. Only active ethnicities are allowed. 
Inactive marital statuses are not allowed in this request.  Inactive marital statuses are not allowed in this request. 
Date of death is only allowed for terminated workers.  Date of death is only allowed for terminated workers. 
Hukou can only be entered for citizens of China.  Hukou can only be entered for citizens of China. 
The Hukou Subregion specified is not valid for the Location Context. The Location Context is derived from the Country of the Location for the Position.  The Hukou Subregion specified is not valid for the Location Context. The Location Context is derived from the Country of the Location 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. 
LGBT Identification is not valid for this country  LGBT Identification is not valid for this country 
A Worker cannot have a Birth Region without a corresponding Birth Country.  A Worker cannot have a Birth Region without a corresponding Birth Country. 
The Hukou Subregion does not exist within the specified Hukou Region or is inactive.  The Hukou Subregion does not exist within the specified Hukou Region or is inactive. 
The visual ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position  The visual ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position 
Multiple Visual Ethnicities are not allowed for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  Multiple Visual Ethnicities are not allowed for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
At least one visual ethnicity in this request is inactive. Only active ethnicities are allowed.  At least one visual ethnicity in this request is inactive. Only active ethnicities are allowed. 
Hispanic or Latino for Visual Survey is only tracked in the USA and must be enabled in tenant setup by your administrator.  Hispanic or Latino for Visual Survey is only tracked in the USA and must be enabled in tenant setup by your administrator. 
You can't enter a value for Contingent Workers for the Visual Survey Ethnicity Reference or the Hispanic or Latino for Visual Survey element.  You can't enter a value for Contingent Workers for the Visual Survey Ethnicity Reference or the Hispanic or Latino for Visual Survey element. 
Sexual Orientation Reference is not valid or in-active.  Sexual Orientation Reference is not valid or in-active. 
Gender Identity Reference is not valid or in-active.  Gender Identity Reference is not valid or in-active. 
Pronoun Reference is not valid or in-active.  Pronoun Reference is not valid or in-active. 
The Sexual Orientation is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Sexual Orientation is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Gender Identity is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Gender Identity is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Pronoun is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Pronoun 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 field Blood Type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Blood Type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
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. 
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. 
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. 
The field Disability is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Disability is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The field Military Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The field Military Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
The field Relatives' Name is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Relatives' Name 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. 
A worker can't have a City of Birth without a corresponding Region of Birth.  A worker can't have a City of Birth without a corresponding Region of Birth. 
 
top
 

Change_Personal_Information_Data

part of: Change_Personal_Information_Sub_Business_Process
Container for the data changed in the Change Personal Information business process.
 
Parameter name Type/Value Cardinality Description Validations
Date_of_Birth  date  [0..1]  Person's Date of Birth. 
Validation Description
Date of birth must precede marital status date, medical exam dates and date of death. This applies to the data in this request as well any existing data on the worker that is not being modified.  Date of birth must precede marital status date, medical exam dates and date of death. This applies to the data in this request as well any existing data on the worker that is not being modified. 
Date of birth must precede all military discharge dates currently on the worker unless all military service data is being replaced.  Date of birth must precede all military discharge dates currently on the worker unless all military service data is being replaced. 
Date of birth must precede all disability status dates currently on the worker unless all disability data is being replaced.  Date of birth must precede all disability status dates currently on the worker unless all disability data is being replaced. 
 
Birth_Country_Reference  CountryObject  [0..1]  Country where the person was born.   
Birth_Region_Reference  Country_RegionObject  [0..1]  Country Region where the person was born. 
Validation Description
The Region of Birth entered is not valid for the corresponding Country of Birth.  The Region of Birth entered is not valid for the corresponding Country of Birth. 
 
Gender_Reference  GenderObject  [0..1]  Reference to the Gender of the person.   
Disability_Information_Data  Disability_Information_Data  [0..1]  Wrapper element for all Disability Status data for the worker.   
Marital_Status_Reference  Marital_StatusObject  [0..1]  Reference for the person's Marital Status.   
Citizenship_Reference  Citizenship_StatusObject  [0..*]  Reference for the person's Citizenship Status.   
Primary_Nationality_Reference  CountryObject  [0..1]  Reference for the 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. 
 
Ethnicity_Reference  EthnicityObject  [0..*]  Reference for the person's Ethnicities.   
Hispanic_or_Latino  boolean  [0..1]  Boolean to indicate if a person is Hispanic or Latino.   
Visual_Survey_Ethnicity_Reference  EthnicityObject  [0..*]  Reference to person's Visual Survey Ethnicities.   
Hispanic_or_Latino_for_Visual_Survey  boolean  [0..1]  Boolean reference to person's Visual Survey for Hispanic or Latino.   
Religion_Reference  ReligionObject  [0..1]  Reference for a person's Religions.   
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. 
Validation Description
Hukou Region must be in China.  Hukou Region must be in 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.   
Native_Region_Reference  Country_RegionObject  [0..1]  Native region on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China.   
Personnel_File_Agency  string  [0..1]  Personnel File Agency is used in China to indicate where workers have their personnel file stored.   
Military_Information_Data  Military_Information_Data  [0..1]  Wrapper element for all Military Service data for the worker.   
Political_Affiliation_Reference  Political_AffiliationObject  [0..1]  Person's Political Affiliation.   
Date_of_Death  date  [0..1]  Person's Date of Death.