Service Directory > v32.1 > Benefits_Administration > Edit_Dependent
 

Operation: Edit_Dependent

This operation updates a dependent.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Edit_Dependent_Request

Wrapper element for the Edit Dependent web service operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Edit_Dependent_Data  Edit_Dependent_Data  [1..1]  Wrapper element for the Edit Dependent web service operation.   
top
 

Response Element: Edit_Dependent_Response

Wrapper element for the response to an Edit Dependent web service operation request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Unique_IdentifierObject  [0..1]  Reference to the event that edits the Dependent.   
Employee_Reference  WorkerObject  [0..1]  Reference to the Employee for this Dependent.   
Dependent_Reference  DependentObject  [0..1]  Reference to the Dependent.   
Exception_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Business_Process_Parameters

part of: Edit_Dependent_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Edit_Dependent_Data

part of: Edit_Dependent_Request
Wrapper element for the Edit Dependent web service operation.
 
Parameter name Type/Value Cardinality Description Validations
Dependent_Reference  DependentObject  [1..1]  Reference to the Dependent being updated.   
Edit_Dependent_Event_Data  Edit_Dependent_Event_Data  [0..1]  Wrapper element for the Dependent's data. 
Validation Description
Dependent ID already exists.   
If you selected Use Employee Address, you cannot specify Address Data.   
If you selected Use Employee Phone, you cannot specify Phone Data.   
You must select a related person relationship that has a dependent relationship type.   
 
top
 

DependentObject

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

DependentObjectID

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

Edit_Dependent_Event_Data

part of: Edit_Dependent_Data
Wrapper element for the Dependent's data.
 
Parameter name Type/Value Cardinality Description Validations
Dependent_ID  string  [0..1]  The new Reference ID for the Dependent.   
Effective_Date  date  [0..1]  The Effective Date for this Edit Dependent event.   
Reason_Reference  Benefits_Event_SubcategoryObject  [0..1]  The Reason for performing this Edit Dependent action.   
Related_Person_Relationship_Reference  Related_Person_RelationshipObject  [0..1]  Reference to the relationship between the dependent and the related person.   
Use_Employee_Address  boolean  [0..1]  If this field is marked true, then the dependent will share the specified employee's primary home address.   
Use_Employee_Phone  boolean  [0..1]  If this field is marked true, then the dependent will share the specified employee's primary home phone data.   
Dependent_Personal_Information_Data  Related_Person_Personal_Information_Data  [0..1]  All of the personal data. This includes name, contact information (Email, Phone, Address, Web, Instant Messenger), Visa and ID information, Biographic, Demographic, and Background Check Information. 
Validation Description
Date of Death must be a date between Date of Birth and today's date.   
The location context of the worker for this dependent does not track dependents for payroll purposes. Dependent for Payroll Purposes must be blank.   
The location context of the worker for this dependent does not track the city of birth. City of Birth must be blank.   
The location context of the worker for this dependent does not track the region of birth. Region of Birth Reference must be blank.   
The location context of the worker for this dependent does not track country of birth. Country of Birth Reference must be blank.   
Country Region [region] is invalid for Country [country].   
The location context of the worker for this dependent does not track nationality. Country of Nationality Reference must be blank.   
The location context of the worker for this dependent does not track citizenship. Citizenship Status Reference must be blank.   
Report a benefit change to remove the dependent from their benefit elections. This dependent can’t be inactivated because they are currently enrolled in benefits.   
The dependent is already inactive.   
The dependent can't be inactivated because they are either not enrolled in benefits or not part of a court order.   
Lives With Worker Data not tracked for Dependent's Localization   
Has Health Insurance Data not tracked for Dependent's Localization   
Allowed for Tax Deduction Data not tracked for Dependent's Localization   
Annual Income Data not tracked for Dependent's Localization   
Occupation Data not tracked for Dependent's Localization   
Advanced Disability Data not tracked for Dependent's Localization   
 
Qualified_Domestic_Relations_Order_Replacement_Data  Qualified_Domestic_Relations_Order_Replacement_Data  [0..*]  Court Order Details. NOTE: You must pass in the entire set of court orders. Any existing court orders that are not submitted will be removed. 
Validation Description
Benefit coverage type is not valid for specified benefit contact. Please ensure that the benefit contact is eligible for the coverage type.   
 
Could_Be_Covered_For_Health_Care_Coverage_Elsewhere  boolean  [0..1]  Marking this field to true for a dependent that is a Spouse or Domestic-Partner means the dependent is or could be enrolled in Health Care coverage elsewhere.   
Could_Be_Covered_For_Health_Care_Coverage_Elsewhere_Effective_Date  date  [0..1]  The Effective Date for the "Could Be Covered For Health Care Coverage Elsewhere" field value.   
Validation Description
Dependent ID already exists.   
If you selected Use Employee Address, you cannot specify Address Data.   
If you selected Use Employee Phone, you cannot specify Phone Data.   
You must select a related person relationship that has a dependent relationship type.   
top
 

Benefits_Event_SubcategoryObject

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

Benefits_Event_SubcategoryObjectID

part of: Benefits_Event_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, Event_Classification_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
 

Related_Person_RelationshipObject

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

Related_Person_RelationshipObjectID

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

Related_Person_Personal_Information_Data

part of: Edit_Dependent_Event_Data
All of the personal data. This includes name, contact information (Email, Phone, Address, Web, Instant Messenger), Visa and ID information, Biographic, Demographic, and Background Check Information.
 
Parameter name Type/Value Cardinality Description Validations
Person_Name_Data  Legal_Name_Data  [0..1]  Contains the legal name for a person. A person must name one and only one legal name.   
Contact_Information_Data  Contact_Information_Data_For_Related_Person  [0..1]  All of the person's contact data (address, phone, email, instant messenger, web address). 
Validation Description
Subject person 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 person 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 person 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 person 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 person 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 person 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. 
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. 
Subject person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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. 
Primary addresses cannot have a future effective date.  We do not allow future dated primary addresses because the task orchestrated Edit Dependent page does not support them. 
 
Person_Identification_Data  Person_Identification_Data  [0..1]  Wrapper for Person Identification Data. Includes National Identifiers, Government Identifiers, Visa Identifiers, Passport Identifiers, License Identifiers and Custom Identifiers.   
Date_of_Birth  date  [0..1]  Person's Date of Birth.   
Date_of_Death  date  [0..1]  Person's date of death.   
Gender_Reference  GenderObject  [0..1]  Reference to the Gender of the person.   
Uses_Tobacco  boolean  [0..1]  Specifies whether employee uses tobacco.   
Full-Time_Student  boolean  [0..1]  Boolean representing whether or not this dependent is a full-time student.   
Student_Status_Start_Date  date  [0..1]  The date the dependent became a full-time student.   
Student_Status_End_Date  date  [0..1]  The date the dependent's student status ended (no longer a full-time student)   
Disabled  boolean  [0..1]  Boolean representing whether or not this dependent is disabled.   
Disability_Data  Disability_Information_Data_for_Related_Person  [0..1]  Disability Data for Dependent   
Inactive_Date  date  [0..1]  If inactive, the date from which dependent is inactive.   
Dependent_for_Payroll_Purposes  boolean  [0..1]  Tells if this dependent's information is used in payroll calculations. Only use if dependents for payroll purposes are being tracked for the location context of the worker for this dependent.   
Citizenship_Status_Reference  Citizenship_StatusObject  [0..*]  Reference to the legal status of the dependent. Only use if citizenship status is being tracked for the location context of the worker for this dependent.   
Country_of_Nationality_Reference  CountryObject  [0..1]  Reference to the primary country of which the dependent is a national. Only use if nationality is being tracked for the location context of the worker for this dependent.   
Country_of_Birth_Reference  CountryObject  [0..1]  Reference to the dependent's country of birth. Only use if the country of birth is being tracked for the location context of the worker for this dependent.   
Region_of_Birth_Reference  Country_RegionObject  [0..1]  Reference to the dependent's country region of birth. Only use if the country and region of birth is being tracked for the location context of the worker for this dependent.   
City_of_Birth  string  [0..1]  The dependent's city of birth. Only use if the city of birth is being tracked for the location context of the worker for this dependent.   
Lives_With_Worker_Data  Lives_With_Worker_Data  [0..1]  If the dependent lives with worker   
Has_Health_Insurance_Data  Has_Health_Insurance_Data  [0..1]  If the dependent has health insurance   
Allowed_for_Tax_Deduction_Data  Allowed_for_Tax_Deduction_Data  [0..1]  If the dependent is allowed for tax deduction   
Annual_Income_Data  Annual_Income_Data  [0..1]  Dependent's Annual Income   
Occupation_Data  Occupation_Data  [0..1]  Occupation of the Dependent   
Validation Description
Date of Death must be a date between Date of Birth and today's date.   
The location context of the worker for this dependent does not track dependents for payroll purposes. Dependent for Payroll Purposes must be blank.   
The location context of the worker for this dependent does not track the city of birth. City of Birth must be blank.   
The location context of the worker for this dependent does not track the region of birth. Region of Birth Reference must be blank.   
The location context of the worker for this dependent does not track country of birth. Country of Birth Reference must be blank.   
Country Region [region] is invalid for Country [country].   
The location context of the worker for this dependent does not track nationality. Country of Nationality Reference must be blank.   
The location context of the worker for this dependent does not track citizenship. Citizenship Status Reference must be blank.   
Report a benefit change to remove the dependent from their benefit elections. This dependent can’t be inactivated because they are currently enrolled in benefits.   
The dependent is already inactive.   
The dependent can't be inactivated because they are either not enrolled in benefits or not part of a court order.   
Lives With Worker Data not tracked for Dependent's Localization   
Has Health Insurance Data not tracked for Dependent's Localization   
Allowed for Tax Deduction Data not tracked for Dependent's Localization   
Annual Income Data not tracked for Dependent's Localization   
Occupation Data not tracked for Dependent's Localization   
Advanced Disability Data not tracked for Dependent's Localization   
top
 

Legal_Name_Data

part of: Related_Person_Personal_Information_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
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, Address_Information_Data, National_ID_Data, Visa_ID_Data, Government_ID_Data, Passport_ID_Data, License_ID_Data, Related_Person_Personal_Information_Data, Related_Person_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
 

Contact_Information_Data_For_Related_Person

part of: Related_Person_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
Subject person 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 person 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 person 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 person 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 person 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 person 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. 
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. 
Subject person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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 person 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. 
Primary addresses cannot have a future effective date.  We do not allow future dated primary addresses because the task orchestrated Edit Dependent page does not support them. 
top
 

Address_Information_Data

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

Country_CityObject

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  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
 

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
 

Country_RegionObject

part of: Address_Information_Data, License_ID_Data, Related_Person_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
 

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_For_Related_Person
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_For_Related_Person
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_For_Related_Person
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_For_Related_Person
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
 

Person_Identification_Data

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

National_ID

part of: Person_Identification_Data
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: National_ID, Government_ID, Visa_ID, Passport_ID, Custom_ID, Edit_Dependent_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

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

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
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
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
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
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
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
 

GenderObject

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

Disability_Information_Data_for_Related_Person

part of: Related_Person_Personal_Information_Data
Wrapper element for all Disability Status data for the Dependent.
 
Parameter name Type/Value Cardinality Description Validations
Replace_All  boolean  [0..1]  When this flag is set to false, existing disability data for the worker will be preserved. When true   
Disability_Status_Information_Data  Disability_Status_Information_Data_for_Related_Person  [0..*]  Wrapper element for each disability status entry.   
top
 

Disability_Status_Information_Data_for_Related_Person

part of: Disability_Information_Data_for_Related_Person
Wrapper element for each disability status entry.
 
Parameter name Type/Value Cardinality Description Validations
Disability_Status_Reference  Disability_Status_ReferenceObject  [0..1]  Reference to an existing Disability Status entry for edits and deletes.   
Delete  boolean  [0..1]  Flag to delete an existing disability status entry. If this flag is set, Disability Status Reference is also required.   
Disability_Status_Data  Disability_Status_Sub_Data_for_Related_Person  [0..1]  Container for disability status data for the Dependent business process. 
Validation Description
The Disability Reference is not valid for this location or Dependent subject type.   
The specified Disability Grade Reference is not valid for this Disability Reference.   
 
top
 

Disability_Status_ReferenceObject

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

Disability_Status_Sub_Data_for_Related_Person

part of: Disability_Status_Information_Data_for_Related_Person
Container for disability status data for the Personal Information Change business process.
 
Parameter name Type/Value Cardinality Description Validations
Disability_Reference  DisabilityObject  [1..1]  The person's disability   
Disability_Status_Date  date  [0..1]  This 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 
 
Date_Known  date  [0..1]  The date you (the employer) first learned about the disability. 
Validation Description
The Disability Date Known cannot be before the Date of Birth.  The Disability Date Known cannot be before the Date of Birth. 
 
Disability_End_Date  date  [0..1]  The date through which the Person 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.  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.   
Validation Description
The Disability Reference is not valid for this location or Dependent subject type.   
The specified Disability Grade Reference is not valid for this Disability Reference.   
top
 

DisabilityObject

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

Citizenship_StatusObject

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

Lives_With_Worker_Data

part of: Related_Person_Personal_Information_Data
If the dependent lives with worker
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The Effective date for if dependent lives with worker   
Lives_With_Worker  boolean  [0..1]  Boolean attribute identifying if the dependent lives with worker   
top
 

Has_Health_Insurance_Data

part of: Related_Person_Personal_Information_Data
If the dependent has health insurance
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The Effective date for if dependent has health insurance   
Has_Health_Insurance  boolean  [0..1]  Boolean attribute identifying if the dependent has health insurance   
top
 

Allowed_for_Tax_Deduction_Data

part of: Related_Person_Personal_Information_Data
If the dependent is allowed for tax deduction
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The Effective date for if dependent is allowed for tax deduction   
Allowed_for_Tax_Deduction  boolean  [0..1]  Boolean attribute identifying if the dependent is allowed for tax deduction   
top
 

Annual_Income_Data

part of: Related_Person_Personal_Information_Data
Dependent's annual income
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The Effective date for dependent's annual income   
Currency_Reference  CurrencyObject  [1..1]  Currency of dependent's income   
Annual_Income  decimal (11, 2) >0   [0..1]  Currency attribute specifying the dependent's annual income   
top
 

CurrencyObject

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

Occupation_Data

part of: Related_Person_Personal_Information_Data
Occupation of the Dependent
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The Effective date for Dependent's Occupation   
Occupation  string  [0..1]  Text attribute describing Dependent's Occupation   
top
 

Qualified_Domestic_Relations_Order_Replacement_Data

part of: Edit_Dependent_Event_Data
Court Order Details. NOTE: You must pass in the entire set of court orders. Any existing court orders that are not submitted will be removed.
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Coverage_Type_Reference  Benefit_Coverage_TypeObject  [1..1]  Enforce court order for this benefit coverage type.   
Start_Date  date  [1..1]  Enforce court order starting on this date.   
End_Date  date  [1..1]  Stop enforcing court order on this date.   
Validation Description
Benefit coverage type is not valid for specified benefit contact. Please ensure that the benefit contact is eligible for the coverage type.   
top
 

Benefit_Coverage_TypeObject

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

Benefit_Coverage_TypeObjectID

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

Application_Instance_Related_Exceptions_Data

part of: Edit_Dependent_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

DependentReferenceEnumeration

part of: DependentObjectID
Base Type
string
top
 

Benefits_Event_SubcategoryReferenceEnumeration

part of: Benefits_Event_SubcategoryObjectID
Base Type
string
top
 

Related_Person_RelationshipReferenceEnumeration

part of: Related_Person_RelationshipObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_Predefined_Person_Name_Component_ValueReferenceEnumeration

part of: Country_Predefined_Person_Name_Component_ValueObjectID
Base Type
string
top
 

Country_CityReferenceEnumeration

part of: Country_CityObjectID
Base Type
string
top
 

Base Type
string

top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Communication_Usage_TypeReferenceEnumeration

part of: Communication_Usage_TypeObjectID
Base Type
string
top
 

Communication_Usage_BehaviorReferenceEnumeration

part of: Communication_Usage_BehaviorObjectID
Base Type
string
top
 

Communication_Usage_Behavior_TenantedReferenceEnumeration

part of: Communication_Usage_Behavior_TenantedObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top
 

Phone_Device_TypeReferenceEnumeration

part of: Phone_Device_TypeObjectID
Base Type
string
top
 

Phone_ReferenceReferenceEnumeration

part of: Phone_ReferenceObjectID
Base Type
string
top
 

Email_ReferenceReferenceEnumeration

part of: Email_ReferenceObjectID
Base Type
string
top
 

Instant_Messenger_TypeReferenceEnumeration

part of: Instant_Messenger_TypeObjectID
Base Type
string
top
 

Instant_Messenger_ReferenceReferenceEnumeration

part of: Instant_Messenger_ReferenceObjectID
Base Type
string
top
 

Web_Address_ReferenceReferenceEnumeration

part of: Web_Address_ReferenceObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

National_ID_TypeReferenceEnumeration

part of: National_ID_TypeObjectID
Base Type
string
top
 

National_Identifier_ReferenceReferenceEnumeration

part of: National_Identifier_ReferenceObjectID
Base Type
string
top
 

Government_ID_Type__All_ReferenceEnumeration

part of: Government_ID_Type__All_ObjectID
Base Type
string
top
 

Government_Identifier_ReferenceReferenceEnumeration

part of: Government_Identifier_ReferenceObjectID
Base Type
string
top
 

Visa_ID_TypeReferenceEnumeration

part of: Visa_ID_TypeObjectID
Base Type
string
top
 

Visa_Identifier_ReferenceReferenceEnumeration

part of: Visa_Identifier_ReferenceObjectID
Base Type
string
top
 

Passport_ID_Type__All_ReferenceEnumeration

part of: Passport_ID_Type__All_ObjectID
Base Type
string
top
 

Passport_Identifier_ReferenceReferenceEnumeration

part of: Passport_Identifier_ReferenceObjectID
Base Type
string
top
 

License_IdentifierReferenceEnumeration

part of: License_IdentifierObjectID
Base Type
string
top
 

License_ID_Type__All_ReferenceEnumeration

part of: License_ID_Type__All_ObjectID
Base Type
string
top
 

AuthorityReferenceEnumeration

part of: AuthorityObjectID
Base Type
string
top
 

License_Identifier_ReferenceReferenceEnumeration

part of: License_Identifier_ReferenceObjectID
Base Type
string
top
 

Custom_ID_TypeReferenceEnumeration

part of: Custom_ID_TypeObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Custom_Identifier_ReferenceReferenceEnumeration

part of: Custom_Identifier_ReferenceObjectID
Base Type
string
top
 

GenderReferenceEnumeration

part of: GenderObjectID
Base Type
string
top
 

Disability_Status_ReferenceReferenceEnumeration

part of: Disability_Status_ReferenceObjectID
Base Type
string
top
 

DisabilityReferenceEnumeration

part of: DisabilityObjectID
Base Type
string
top
 

Disability_GradeReferenceEnumeration

part of: Disability_GradeObjectID
Base Type
string
top
 

Citizenship_StatusReferenceEnumeration

part of: Citizenship_StatusObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Benefit_Coverage_TypeReferenceEnumeration

part of: Benefit_Coverage_TypeObjectID
Base Type
string
top