Service Directory > v23.0 > Benefits_Administration > Put_Dependent
 

Operation: Put_Dependent DEPRECATED

DEPRECATED: Adds or 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: Put_Dependent_Request

Wrapper element for the Put Dependent Request Information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Dependent_Reference  DependentObject  [0..1]  The reference to the Dependent being updated. For new Dependents, this reference will not exist.   
Dependent_Data  Put_Dependent_Data  [1..1]  The Wrapper data element for the Put Dependent Web Service. 
Validation Description
If a Related Person is selected, s/he must be related to the Employee.   
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.   
The Existing Related Person must have a Gender defined or the Gender must be provided.   
The Existing Related Person must have a Date of Birth defined or Date of Birth must be specified.   
The Existing Related Person must have an Address or the Address must be specified.   
 
Validation Description
If you are updating an existing Dependent, you cannot select an Existing Related Person to update.   
You must select an Employee when a new Dependent is being created, but not when an existing Dependent is being updated.   
You must select a Related Person Relationship when a new Dependent is being created.   
If a new Dependent is being created and an existing related person is not supplied, Dependent Personal Information Data must be supplied.   
If a new Dependent is being created and an existing related person is not supplied, Legal Name Data is required.   
If a new Dependent is being created and an existing related person is not supplied, one email, one phone number, or one address is required.   
If you selected Use Employee Address, the employee for this dependent must have a primary home address.   
If you selected Use Employee Phone, the employee for this dependent must have a primary home phone number.   
If a new Dependent is being created and an existing related person is not supplied, Gender is required.   
If a new Dependent is being created and an existing related person is not supplied, Date of Birth is required.   
The selected Existing Related Person is already a Dependent for the selected Employee.   
Irrevocable may be set only for employees in Quebec.   
If a new dependent is being created, an address is required.   
Dependent ID already exists.   
This dependent is currently enrolled in benefits. You must report a benefit change to remove the dependent from their elections before the date of death can be entered and they are inactivated.   
Dependent ID already exists.   
top
 

Response Element: Put_Dependent_Response

Wrapper element for the Put Dependent Returned data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Dependent_Reference  DependentObject  [0..1]  The reference to the dependent which was added or updated.   
Employee_Reference  EmployeeObject  [0..1]  The reference to the employee for the dependent.   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

DependentObject

part of: Put_Dependent_Request, Put_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
 

Put_Dependent_Data

part of: Put_Dependent_Request
The Wrapper data element for the Put Dependent Web Service.
 
Parameter name Type/Value Cardinality Description Validations
Dependent_ID  string  [0..1]  The Reference ID for the Dependent. This field can be used to fill in the ID value for a newly created Dependent, or to update the ID of an existing Dependent.   
Employee_Reference  EmployeeObject  [0..1]  A reference to the Employee for the Dependent.   
Existing_Related_Person_Reference  Related_Person_for_WorkerObject  [0..1]  Reference to an existing related person for the Dependent. If this field is populated, this dependent's personal information data will be shared with the person specified.   
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.   
Irrevocable  boolean  [0..1]  If this field is marked true, any new beneficiaries that are created will be marked as "Irrevocable".   
Dependent_Personal_Information_Data  Dependent_Personal_Information_Data  [0..1]  Wrapper element for this dependent's personal information. 
Validation Description
Date of Death must be a date between Date of Birth and today's date.   
Preferred names cannot be specified for dependents.   
 
Court_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.   
 
Validation Description
If a Related Person is selected, s/he must be related to the Employee.   
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.   
The Existing Related Person must have a Gender defined or the Gender must be provided.   
The Existing Related Person must have a Date of Birth defined or Date of Birth must be specified.   
The Existing Related Person must have an Address or the Address must be specified.   
top
 

EmployeeObject

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

EmployeeObjectID

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

Related_Person_for_WorkerObject

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

Related_Person_for_WorkerObjectID

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

Dependent_Personal_Information_Data

part of: Put_Dependent_Data
Wrapper element for this dependent's personal information.
 
Parameter name Type/Value Cardinality Description Validations
Person_Name_Data  Person_Name_Data  [0..1]  Wrapper element for this dependent's name data.   
Contact_Information_Data  Contact_Information_Data  [0..1]  Wrapper element for this dependent's contact information. 
Validation Description
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
 
Person_Identification_Data  Person_Identification_Data  [0..1]  Wrapper element for this dependent's ID data.   
Date_of_Birth  date  [0..1]  The date of birth of the dependent.   
Date_of_Death  date  [0..1]  The date of death of the dependent.   
Gender_Reference  GenderObject  [0..1]  The gender of the dependent.   
Uses_Tobacco  boolean  [0..1]  Boolean representing whether or not this dependent 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.   
Inactive_Date  date  [0..1]  If inactive, the date from which dependent is inactive.   
Validation Description
Date of Death must be a date between Date of Birth and today's date.   
Preferred names cannot be specified for dependents.   
top
 

Person_Name_Data

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

Legal_Name_Data

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

Person_Name_Detail_Data

part of: Legal_Name_Data, Preferred_Name_Data, Additional_Name_Data
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, in one string, a fully formatted name with 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, in one string, a fully formatted name for reporting with all of its pieces in their proper place. This name is only used in a response and is not used for requests.   
Country_Reference  CountryObject  [1..1]  The country that the name is for. 
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.   
 
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.   
 
Secondary_Last_Name  string  [0..1]  The secondary last name (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.   
 
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 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
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an 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]  A reference to the title for 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].   
 
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 to as Family Name, for supporting countries.   
Secondary_Last_Name  string  [0..1]  Contains secondary last name in local script, which is generally configured to as Maternal Family Name, for supporting countries.   
First_Name_2  string  [0..1]  Contains first name in second local script, which is generally configured to as Given Name, for supporting countries.   
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 to as Given Name, for supporting countries.   
Secondary_Last_Name_2  string  [0..1]  Contains secondary last name in second local script, which is generally configured to 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 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].   
 
Academic_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the academic suffix for a person. This is only valid for the country of Australia. 
Validation Description
Academic Suffix is required for this country.   
Academic Suffix is not setup for this country.   
[academic suffix] is not a valid academic suffix value for [country].   
 
Hereditary_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the hereditary suffix for a person. This is only valid for the country of Australia. 
Validation Description
Hereditary Suffix is required for this country.   
Hereditary Suffix is not setup for this country.   
[hereditary suffix] is not a valid hereditary suffix value for [country].   
 
Honorary_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the honorary suffix for a person. This is only valid for the country of Australia. 
Validation Description
Honorary Suffix is required for this country.   
Honorary Suffix is not setup for this country.   
[honorary suffix] is not a valid honorary suffix value for [country].   
 
Professional_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the professional suffix for a person. This is only valid for the country of Australia. 
Validation Description
Professional Suffix is required for this country.   
Professional Suffix is not setup for this country.   
[professional suffix] is not a valid professional suffix value for [country].   
 
Religious_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the religious suffix for a person. This is only valid for the country of Australia. 
Validation Description
Religious Suffix is required for this country.   
Religious Suffix is not setup for this country.   
[religious suffix] is not a valid religious suffix value for [country].   
 
Royal_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the royal suffix for a person. This is only valid for the country of Australia. 
Validation Description
Royal Suffix is required for this country.   
Royal Suffix is not setup for this country.   
[royal suffix] is not a valid royal suffix value for [country].   
 
top
 

Preferred_Name_Data

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

Additional_Name_Data

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

Additional_Name_TypeObject

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

Additional_Name_TypeObjectID

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

Contact_Information_Data

part of: Dependent_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. 
Address Line is required for certain countries.  Address Line 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 
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. 
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.   
 
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.   
Element Content 'Phone Number' is required, on internal element 'Phone Information Data'  Element Content 'Phone Number' is required, on internal element 'Phone Information Data' 
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' 
 
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.   
 
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.   
 
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. 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
You cannot specify the same usage type more than once for an address.   
 
Validation Description
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
top
 

Address_Information_Data

part of: Contact_Information_Data
Address information
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Address  string  [1..1]  Returns the formatted address in the format specified for the country. This data is not used for inbound requests and any data provided in this element will be ignored.   
@Address_Format_Type  string  [1..1]  The format type of the address.   
@Defaulted_Business_Site_Address  boolean  [1..1]  Set to 1 if the address is a defaulted location address. If this value is 1, this address will not be processed for inbound web services.   
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced address. If this flag is set, the Reference ID field becomes required, and all other address fields that would otherwise be required will be optional and meaningless. 
Validation Description
The referenced address is in use as a primary home address and cannot be deleted.  The referenced address is in use as a primary home address and cannot be deleted. 
 
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary address data will be replaced. A value of true means only the referenced address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY address in the request.   
@Effective_Date  date  [1..1]  Effective Date of Address.   
Country_Reference  CountryObject  [0..1]  Country for the address.   
Last_Modified  dateTime  [0..1]  The moment when the address was last modified.   
Address_Line_Data  Address_Line_Information_Data  [0..*]  The address line for the address. This typically contains Street name, street number, apartment, suite number. 
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
 
Municipality  string  [0..1]  City part of 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.   
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.   
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. 
Address Line is required for certain countries.  Address Line 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 
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. 
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.   
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. 
 
@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. 
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
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an 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  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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..*]  Encapsulation element for the Communication Usage Type.   
Use_For_Reference  Communication_Usage_BehaviorObject  [0..*]  Reference ID for Communication Usage Behavior. 
Validation Description
Please provide usages that are Workday Owned or Tenanted - not both.   
 
Use_For_Tenanted_Reference  Communication_Usage_Behavior_TenantedObject  [0..*]  Reference ID for Communication Usage Behavior Tenanted. 
Validation Description
Please provide usages that are Workday Owned or Tenanted - not both.   
 
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
Encapsulation element for the Communication Usage Type.
 
Parameter name Type/Value Cardinality Description Validations
@Primary  boolean  [1..1]  Indicates if the communication method is Primary.   
Type_Reference  Communication_Usage_TypeObject  [1..1]  Reference ID for the Communication Usage Type.   
top
 

Communication_Usage_TypeObject

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

Communication_Usage_TypeObjectID

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

Communication_Usage_BehaviorObject

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

Communication_Usage_BehaviorObjectID

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

Communication_Usage_Behavior_TenantedObject

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

Communication_Usage_Behavior_TenantedObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Phone_Information_Data

part of: Contact_Information_Data
Phone Information
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Phone  string  [1..1]  The formatted Phone number. This data is not used in inbound requests. Any data provided for this attribute will be ignored.   
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 f or the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, Country Phone Code '1' is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica and Puerto Rico)   
International_Phone_Code  string  [0..1]  International Phone Code Number   
Area_Code  string  [0..1]  Area Code Number 
Validation Description
Enter an area code in the valid format: [AreaCodeValidationMessage]   
 
Phone_Number  string  [0..1]  Phone Number 
Validation Description
Enter a phone number in the valid format: [PhoneValidationMessage].   
 
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  [1..*]  Encapsulating element for all Communication Method Usage data.   
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.   
Element Content 'Phone Number' is required, on internal element 'Phone Information Data'  Element Content 'Phone Number' is required, on internal element 'Phone Information Data' 
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' 
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
 

Email_Address_Information_Data

part of: Contact_Information_Data
Email Address Information
 
Parameter name Type/Value Cardinality Description Validations
Email_Address  string  [1..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  [1..*]  Encapsulating element for all Communication Method Usage data.   
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.   
top
 

Instant_Messenger_Information_Data

part of: Contact_Information_Data
Instant Messenger Address.
 
Parameter name Type/Value Cardinality Description Validations
Instant_Messenger_Address  string  [1..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  [1..*]  Encapsulating element for all Communication Method Usage data.   
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.   
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
 

Web_address_Information_Data

part of: Contact_Information_Data
Web Address Information
 
Parameter name Type/Value Cardinality Description Validations
Web_Address  string  [1..1]  Web Address (e.g. URL).   
Web_Address_Comment  string  [0..1]  Web Address Comment.   
Usage_Data  Communication_Method_Usage_Information_Data  [1..*]  Encapsulating element for all Communication Method Usage data.   
Validation Description
Invalid Usage Type and Use For combination for Web Address.  Invalid Usage Type and Use For combination for Web Address. 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
You cannot specify the same usage type more than once for an address.   
top
 

Person_Identification_Data

part of: Dependent_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
National Identifier [identifier] with workday id [workday id] is not a valid national identifier for the person.   
The National ID referenced by [national identifier reference] does not belong to [worker].   
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.   
 
Government_ID  Government_ID  [0..*]  Wrapper element for all Government Identifier Data. 
Validation Description
Government Identifier [identifier] with workday id [workday id] is not a valid government identifier for the person.   
The Government ID referenced by [government identifier reference] does not belong to [worker].   
If ID is marked for deletion, a Government Identifier Shared Reference should be included.   
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.   
 
Visa_ID  Visa_ID  [0..*]  Wrapper element for all Visa Identifier Data. 
Validation Description
Visa Identifier [identifier] with workday id [workday id] is not a valid visa identifier for the person.   
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.   
The Visa ID referenced by [visa identifier reference] does not belong to [worker].   
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.   
 
Passport_ID  Passport_ID  [0..*]  Wrapper element for all Passport Identifier Data. 
Validation Description
Passport Identifier [identifier] with workday id [workday id] is not a valid passport identifier for the person.   
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.   
The Passport ID referenced by [passport identifier reference] does not belong to [worker].   
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.   
 
License_ID  License_ID  [0..*]  Wrapper element for all License Identifier Data. 
Validation Description
License Identifier [identifier] with workday id [workday id] is not a valid license identifier for the person.   
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.   
The License referenced by [license identifier reference] does not belong to [worker].   
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.   
 
Custom_ID  Custom_ID  [0..*]  Wrapper element for all Custom Identifier Data. 
Validation Description
Custom Identifier [identifier] with workday id [workday id] is not a valid custom identifier for the person.   
The Custom ID referenced by [custom identifier reference] does not belong to [worker].   
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.   
 
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 Replay All has been set to False, the ID will be deleted once the web service is submitted.   
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.  If the National ID Type specified by the ID Type tracks Series, then Series is required. 
 
National_ID_Shared_Reference  National_Identifier_ReferenceObject  [0..1]  Shared reference ID for National Identifiers.   
Validation Description
National Identifier [identifier] with workday id [workday id] is not a valid national identifier for the person.   
The National ID referenced by [national identifier reference] does not belong to [worker].   
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.   
top
 

Unique_IdentifierObject

part of: National_ID, Government_ID, Visa_ID, Passport_ID, 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  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   
 
ID_Type_Reference  National_ID_TypeObject  [0..1]  National Identifier Type 
Validation Description
National ID Type required.   
 
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 used in a select group of countries 
Validation Description
The ID Type ([IDType]) does not allow Series to be specified.   
 
Issuing_Agency  string  [0..1]  Issuing Agency is used in a select group of countries 
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.  If the National ID Type specified by the ID Type tracks Series, then Series is required. 
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
 

WorkerObject

part of: National_ID_Data, Visa_ID_Data, Government_ID_Data, Passport_ID_Data, 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  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
 

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 Replay All has been set to False, the ID will be deleted once the web service is submitted.   
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
Government Identifier [identifier] with workday id [workday id] is not a valid government identifier for the person.   
The Government ID referenced by [government identifier reference] does not belong to [worker].   
If ID is marked for deletion, a Government Identifier Shared Reference should be included.   
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.   
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]   
 
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 Replay All has been set to False, the ID will be deleted once the web service is submitted.   
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
Visa Identifier [identifier] with workday id [workday id] is not a valid visa identifier for the person.   
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.   
The Visa ID referenced by [visa identifier reference] does not belong to [worker].   
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.   
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]   
 
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 Replay All has been set to False, the ID will be deleted once the web service is submitted.   
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
Passport Identifier [identifier] with workday id [workday id] is not a valid passport identifier for the person.   
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.   
The Passport ID referenced by [passport identifier reference] does not belong to [worker].   
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.   
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]   
 
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]  Veritification 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 Replay All has been set to False, the ID will be deleted once the web service is submitted.   
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
License Identifier [identifier] with workday id [workday id] is not a valid license identifier for the person.   
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.   
The License referenced by [license identifier reference] does not belong to [worker].   
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.   
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.   
 
Country_Reference  CountryObject  [0..1]  Country issuing the license identifier. No more than one of of 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 of of 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 of of 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 Replay All has been set to False, the ID will be deleted once the web service is submitted.   
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
Custom Identifier [identifier] with workday id [workday id] is not a valid custom identifier for the person.   
The Custom ID referenced by [custom identifier reference] does not belong to [worker].   
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.   
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.   
 
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: Dependent_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
 

Qualified_Domestic_Relations_Order_Replacement_Data

part of: Put_Dependent_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: Put_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
 

DependentReferenceEnumeration

part of: DependentObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Related_Person_for_WorkerReferenceEnumeration

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

Additional_Name_TypeReferenceEnumeration

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

Instant_Messenger_TypeReferenceEnumeration

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

WorkerReferenceEnumeration

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

Benefit_Coverage_TypeReferenceEnumeration

part of: Benefit_Coverage_TypeObjectID
Base Type
string
top