Service Directory > v33.1 > Human_Resources > Change_Additional_Names
 

Operation: Change_Additional_Names

Sets a worker's additional names. Does not use an event.


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

This web service allows updates to the additional names of a worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Change_Additional_Names_Data  Change_Additional_Name_Data  [1..1]  Reference to the Worker that the additional name data will be applied to.   
top
 

Response Element: Change_Additional_Names_Response

Response for the Change Additional Names web service request. Includes the worker reference and additional name data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Person_Additional_Name_Change_Reference  Unique_IdentifierObject  [0..1]  Event ID of the Additional Name Change Event Lite.   
Worker_Reference  WorkerObject  [0..1]  Reference to the Worker that the additional name data will be applied to.   
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
 

Change_Additional_Name_Data

part of: Change_Additional_Names_Request
Wrapper element for Additional Name Change web service.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Reference to the Worker that the additional name data will be applied to.   
Replace_All  boolean  [0..1]  This flag controls whether or not to replace existing additional names for the worker. When true, existing additional names are removed before the data in this web service request is processed.   
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
 

WorkerObject

part of: Change_Additional_Names_Response, Change_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  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
 

Additional_Name_Data

part of: Change_Additional_Names_Response, Change_Additional_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. 
Validation Description
First Name is not set up for this country.  First Name can only be set for countries that accept it. 
Tertiary Last Name is not set up for this country.  Tertiary Last Name can only be set for countries that accept it. 
First Name (or Local First Name if configured) is required for this country.  First Name (or Local First Name if configured) is required for this country. 
Last Name is not set up for this country.  Last Name can only be set for countries that accept it. 
You must enter a Title for this country.  You must enter a Title for this country. 
You must enter a Tertiary Last Name for this country.  You must enter a Tertiary Last Name for this country. 
Middle Name is not set up for this country.  Middle Name can only be set for countries that accept it. 
You must enter a Local Middle Name for this country.  You must enter a Local Middle Name for this country. 
Secondary Last Name is not set up for this country.  Secondary Last Name can only be set for countries that accept it. 
Full Name is not set up for this country.  Full Name is not set up for this country. 
You must enter a Last Name for this country.  You must enter a Last Name for this country. 
You must enter a Religious Suffix for this country.  You must enter a Religious Suffix for this country. 
You must enter a Local First Name for this country.  You must enter a Local First Name for this country. 
The Last Name field accepts only Western script.  The Last Name field accepts only Western script. 
You must enter a Royal Suffix for this country.  You must enter a Royal Suffix for this country. 
Last Name (or Local Last Name if configured) is required for this country.  Last Name (or Local Last Name if configured) is required for this country. 
You must enter an Honorary Suffix for this country.  You must enter an Honorary Suffix for this country. 
The First Name field accepts only Western script.  The First Name field accepts only Western script. 
You must enter a Salutation for this country.  You must enter a Salutation for this country. 
You must enter a Local Last Name for this country.  You must enter a Local Last Name for this country. 
You must enter an Academic Suffix for this country.  You must enter an Academic Suffix for this country. 
You must enter a Professional Suffix for this country.  You must enter a Professional Suffix for this country. 
You must enter a Hereditary Suffix for this country.  You must enter a Hereditary Suffix for this country. 
You must enter a Local First Name 2 for this country.  You must enter a Local First Name 2 for this country. 
You must enter a Middle Name for this country.  You must enter a Middle Name for this country. 
You must enter a Full Name for this country.  You must enter a Full Name for this country. 
You must enter a Local Middle Name 2 for this country.  You must enter a Local Middle Name 2 for this country. 
You must enter a Secondary Last Name for this country.  You must enter a Secondary Last Name for this country. 
You must enter a Local Last Name 2 for this country.  You must enter a Local Last Name 2 for this country. 
You must enter a Local Secondary Last Name 2 for this country.  You must enter a Local Secondary Last Name 2 for this country. 
You must enter a Social Suffix for this country.  You must enter a Social Suffix for this country. 
You must enter a First Name for this country.  You must enter a First Name for this country. 
You must enter a Local Secondary Last Name for this country.  You must enter a Local Secondary Last Name for this country. 
If one western script is submitted, all required western script name fields must be submitted.  If one western script is submitted, all required western script name fields must be submitted. 
Secondary Last Name (or Local Secondary Last Name) is required for this country.  Secondary Last Name (or Local Secondary Last Name) is required for this country. 
 
Name_Type_Reference  Additional_Name_TypeObject  [0..1]  The type of Additional Name that the name is.   
top
 

Person_Name_Detail_Data

part of: 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 a fully formatted name in one string that has all of its pieces in their proper place. This name is only used in a response and is not used for requests   
@Reporting_Name  string  [1..1]  Contains a fully formatted name in one string for reporting that has all of its pieces in their proper place. This name is only used in a response and is not used for request   
Country_Reference  CountryObject  [1..1]  The Country that the name is in reference to.   
Prefix_Data  Person_Name_Prefix_Data  [0..1]  Contains the prefixes for a name. 
Validation Description
Salutation is not set up for this country.  Salutation is not set up for this country. 
Title is not set up for this country.  Title is not set up for this country. 
[title] is not a valid title value for [country].   
[salutation] is not a valid salutation value for [country].   
 
First_Name  string  [0..1]  The First Name (Given Name) for a person.   
Middle_Name  string  [0..1]  The Middle Name for a person.   
Last_Name  string  [0..1]  The Last Name (Family Name) for a person.   
Secondary_Last_Name  string  [0..1]  The Secondary Last Name (Secondary Family Name) for a person.   
Tertiary_Last_Name  string  [0..1]  The Tertiary Last Name for a person.   
Local_Name_Detail_Data  Local_Person_Name_Detail_Data  [0..1]  Contains the name components in local script for supporting countries. 
Validation Description
Local Last Name is not set up for this country.  Local Last Name is not set up for this country. 
Local First Name 2 is not set up for this country.  Local First Name 2 is not set up for this country. 
If one local script is submitted, all required local script name fields must be submitted.  If one local script is submitted, all required local script name fields must be submitted. 
Local First Name is not set up for this country.  Local First Name is not set up for this country. 
Local Last Name 2 is not set up for this country.  Local Last Name 2 is not set up for this country. 
Local Middle Name is not set up for this country.  Local Middle Name is not set up for this country. 
Local Middle Name 2 is not set up for this country.  Local Middle Name 2 is not set up for this country. 
The Local Last Name 2 field accepts only Kana script.  The Local Last Name 2 field accepts only Kana script. 
Local Secondary Last Name is not set up for this country.  Local Secondary Last Name is not set up for this country. 
Local Secondary Last Name 2 is not set up for this country.  Local Secondary Last Name 2 is not set up for this country. 
The Local First Name 2 field accepts only Kana script.  The Local First Name 2 field accepts only Kana script. 
 
Suffix_Data  Person_Name_Suffix_Data  [0..1]  Contains the suffixes for a name. 
Validation Description
Academic Suffix is not set up for this country.  Academic Suffix is not set up for this country. 
Religious Suffix is not set up for this country.  Religious Suffix is not set up for this country. 
Social Suffix is not set up for this country.  Social Suffix is not set up for this country. 
Honorary Suffix is not set up for this country.  Honorary Suffix is not set up for this country. 
Royal Suffix is not set up for this country.  Royal Suffix is not set up for this country. 
Professional Suffix is not set up for this country.  Professional Suffix is not set up for this country. 
Hereditary Suffix is not set up for this country.  Hereditary Suffix is not set up for this country. 
[royal suffix] is not a valid royal suffix value for [country].   
[religious suffix] is not a valid religious suffix value for [country].   
[hereditary suffix] is not a valid hereditary suffix value for [country].   
[honorary suffix] is not a valid honorary suffix value for [country].   
[professional suffix] is not a valid professional suffix value for [country].   
[academic suffix] is not a valid academic suffix value for [country].   
[social suffix] is not a valid social suffix value for [country].   
 
Full_Name_for_Singapore_and_Malaysia  string  [0..1]  Full Person Name is used by Malaysia and Singapore. It is designed for (eliminate space between these two words) Workers in these countries to enter their Full Legal Name. It is an attribute of Global Person Name Class and is not a concatenation of First and Last Names.   
Validation Description
First Name is not set up for this country.  First Name can only be set for countries that accept it. 
Tertiary Last Name is not set up for this country.  Tertiary Last Name can only be set for countries that accept it. 
First Name (or Local First Name if configured) is required for this country.  First Name (or Local First Name if configured) is required for this country. 
Last Name is not set up for this country.  Last Name can only be set for countries that accept it. 
You must enter a Title for this country.  You must enter a Title for this country. 
You must enter a Tertiary Last Name for this country.  You must enter a Tertiary Last Name for this country. 
Middle Name is not set up for this country.  Middle Name can only be set for countries that accept it. 
You must enter a Local Middle Name for this country.  You must enter a Local Middle Name for this country. 
Secondary Last Name is not set up for this country.  Secondary Last Name can only be set for countries that accept it. 
Full Name is not set up for this country.  Full Name is not set up for this country. 
You must enter a Last Name for this country.  You must enter a Last Name for this country. 
You must enter a Religious Suffix for this country.  You must enter a Religious Suffix for this country. 
You must enter a Local First Name for this country.  You must enter a Local First Name for this country. 
The Last Name field accepts only Western script.  The Last Name field accepts only Western script. 
You must enter a Royal Suffix for this country.  You must enter a Royal Suffix for this country. 
Last Name (or Local Last Name if configured) is required for this country.  Last Name (or Local Last Name if configured) is required for this country. 
You must enter an Honorary Suffix for this country.  You must enter an Honorary Suffix for this country. 
The First Name field accepts only Western script.  The First Name field accepts only Western script. 
You must enter a Salutation for this country.  You must enter a Salutation for this country. 
You must enter a Local Last Name for this country.  You must enter a Local Last Name for this country. 
You must enter an Academic Suffix for this country.  You must enter an Academic Suffix for this country. 
You must enter a Professional Suffix for this country.  You must enter a Professional Suffix for this country. 
You must enter a Hereditary Suffix for this country.  You must enter a Hereditary Suffix for this country. 
You must enter a Local First Name 2 for this country.  You must enter a Local First Name 2 for this country. 
You must enter a Middle Name for this country.  You must enter a Middle Name for this country. 
You must enter a Full Name for this country.  You must enter a Full Name for this country. 
You must enter a Local Middle Name 2 for this country.  You must enter a Local Middle Name 2 for this country. 
You must enter a Secondary Last Name for this country.  You must enter a Secondary Last Name for this country. 
You must enter a Local Last Name 2 for this country.  You must enter a Local Last Name 2 for this country. 
You must enter a Local Secondary Last Name 2 for this country.  You must enter a Local Secondary Last Name 2 for this country. 
You must enter a Social Suffix for this country.  You must enter a Social Suffix for this country. 
You must enter a First Name for this country.  You must enter a First Name for this country. 
You must enter a Local Secondary Last Name for this country.  You must enter a Local Secondary Last Name for this country. 
If one western script is submitted, all required western script name fields must be submitted.  If one western script is submitted, all required western script name fields must be submitted. 
Secondary Last Name (or Local Secondary Last Name) is required for this country.  Secondary Last Name (or Local Secondary Last Name) is required for this country. 
top
 

CountryObject

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

CountryObjectID

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

Person_Name_Prefix_Data

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

Country_Predefined_Person_Name_Component_ValueObject

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

Country_Predefined_Person_Name_Component_ValueObjectID

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

Local_Person_Name_Detail_Data

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

Person_Name_Suffix_Data

part of: Person_Name_Detail_Data
Contains the suffixes for a name.
 
Parameter name Type/Value Cardinality Description Validations
Social_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the description of Social Suffix for a person.   
Social_Suffix_Descriptor  string  [0..1]  A reference to the description of Social Suffix for a person.   
Academic_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Academic Suffix for a person. This is only valid for the country of Australia.   
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.   
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.   
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.   
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.   
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
Academic Suffix is not set up for this country.  Academic Suffix is not set up for this country. 
Religious Suffix is not set up for this country.  Religious Suffix is not set up for this country. 
Social Suffix is not set up for this country.  Social Suffix is not set up for this country. 
Honorary Suffix is not set up for this country.  Honorary Suffix is not set up for this country. 
Royal Suffix is not set up for this country.  Royal Suffix is not set up for this country. 
Professional Suffix is not set up for this country.  Professional Suffix is not set up for this country. 
Hereditary Suffix is not set up for this country.  Hereditary Suffix is not set up for this country. 
[royal suffix] is not a valid royal suffix value for [country].   
[religious suffix] is not a valid religious suffix value for [country].   
[hereditary suffix] is not a valid hereditary suffix value for [country].   
[honorary suffix] is not a valid honorary suffix value for [country].   
[professional suffix] is not a valid professional suffix value for [country].   
[academic suffix] is not a valid academic suffix value for [country].   
[social suffix] is not a valid social suffix value for [country].   
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
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

WorkerReferenceEnumeration

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top