Request element used to find and get workers and their associated data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@version	string	[0..1]	Web Service version
Request_References	Worker_Request_References	[0..1]	Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.
Request_Criteria	Worker_Request_Criteria	[0..1]	The Request Criteria element lets you apply additional criteria to identify the specific instance(s) of a Worker.
Response_Filter	Response_Filter	[0..1]	Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.	Validation Description Page Number cannot be zero.  Page number cannot be zero.
Response_Group	Worker_Response_Group	[0..1]	Use the response group to limit the response to the data you are interested in. If the request does not set any values for the response group, then the response by default returns the following elements: Reference, Personal Data, Employment Data, Compensation Data, Organization Data, and Role Data.

Response element containing an instances of workers and their associated data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@version	string	[0..1]	Web Service version
Request_References	Worker_Request_References	[0..1]	Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.
Request_Criteria	Worker_Request_Criteria	[0..1]	The Request Criteria element lets you apply additional criteria to identify the specific instance(s) of a Worker.
Response_Filter	Response_Filter	[0..1]	Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.	Validation Description Page Number cannot be zero.  Page number cannot be zero.
Response_Group	Worker_Response_Group	[0..1]	Use the response group to limit the response to the data you are interested in. If the request does not set any values for the response group, then the response by default returns the following elements: Reference, Personal Data, Employment Data, Compensation Data, Organization Data, and Role Data.
Response_Results	Response_Results	[0..1]	The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
Response_Data	Workers_Response_Data	[0..1]	Contains each Worker based on the Request References or Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the worker.

Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Skip_Non_Existing_Instances	boolean	[0..1]
Worker_Reference	WorkerObject	[1..*]	A reference to the ID of the worker. The ID consists of a type attribute, which should be set to "Employee_ID" or "Contingent_Worker_ID", and a value attribute, such as "04345".

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

The Request Criteria element lets you apply additional criteria to identify the specific instance(s) of a Worker.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Transaction_Log_Criteria_Data	Transaction_Log_Criteria	[0..*]	Transaction Log Criteria Data	Validation Description Subscriber Reference must have an enabled Transaction Log Service configuration.  Subscriber Reference must have an enabled Transaction Log Service configuration.
Organization_Reference	OrganizationObject	[0..*]	Unique Identifier for a Supervisory Organization
Include_Subordinate_Organizations	boolean	[0..1]	When this boolean value is set to true, indicates to include all subordinate organizations to the Organization Reference in the response.
Position_Reference	Position_ElementObject	[0..*]	Unique identifier for the position of the worker.
Event_Reference	Transaction_LogObject	[0..1]	The identifier of an existing Event.
Benefit_Plan_Reference	Benefit_PlanObject	[0..*]	The unique identifier to a benefits plan, along with a string describing the benefits plan. Identifies the benefit plan or plans that can be used for Benefit Enrollment and Benefit Eligibility. Enrollment is checked when the benefit plan year falls within the effective date. Otherwise, if the benefit plan year falls outside of the effective data, then eligibility is checked.
Field_And_Parameter_Criteria_Data	Field_And_Parameter_Criteria_Data	[0..1]	Field Result Request Criteria
National_ID_Criteria_Data	Worker_by_National_ID_Request_Criteria	[0..*]	National Id request criteria.
Exclude_Inactive_Workers	boolean	[0..1]	Excludes from the response terminated employees or contingent workers whose contracts have ended. (See also: Exclude_Employees, Exclude_Contingent_Workers)
Exclude_Employees	boolean	[0..1]	Excludes employees from inclusion in the response. (See also: Exclude_Inactive_Workers, Exclude_Contingent_Workers)
Exclude_Contingent_Workers	boolean	[0..1]	Excludes contingent workers from inclusion in the response. (See also: Exclude_Inactive_Workers, Exclude_Employees)

Searches the transaction log for business processes and event lites to find specific events that occurred during a period of time.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Transaction_Date_Range_Data	Effective_And_Updated_DateTime_Data	[0..1]	Encapsulating element containing Effective and Updated DateTime data.	Validation Description Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment!  Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through!  If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required!  Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through!
Transaction_Type_References [Choice]	Transaction_Type_References	[0..1]	If specified, this search criteria will return those Transaction Log Entries which match the Transaction Types specified here.
Subscriber_Reference [Choice]	SubscriberObject	[0..1]	If specified, this search criterium will return those Transaction Log Entries that match the Transaction Types defined in the subscription of the subscriber.

Validation Description Subscriber Reference must have an enabled Transaction Log Service configuration.  Subscriber Reference must have an enabled Transaction Log Service configuration.

Element contains effective and updated date/time data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Updated_From	dateTime	[0..1]	Defines the earliest moment (e.g. datetime) data was entered into the Workday system.
Updated_Through	dateTime	[0..1]	Defines the latest moment (e.g. datetime) data was entered into the Workday system.
Effective_From	dateTime	[0..1]	Defines the earliest Effective Date (e.g. As Of Date) data is marked within the Workday system.
Effective_Through	dateTime	[0..1]	Defines the latest Effective Date (e.g. As Of Date) data is marked within the Workday system.

Validation Description Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment!  Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through!  If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required!  Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through!

Wrapper element containing Transaction Types.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Transaction_Type_Reference	Transaction_Log_TypeObject	[0..*]	If specified, this search criterium will return those Transaction Log Entries with Transaction Types that match the search criterium.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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	Transaction_Log_TypeObjectID	[0..*]	Contains a unique identifier for an instance of an object.

Contains a unique identifier for an instance of an object.

 

Parameter name	Type/Value	Cardinality	Description	Validations
#text	string
@type	WID, Business_Process_Type	[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".

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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	SubscriberObjectID	[0..*]	Contains a unique identifier for an instance of an object.

Contains a unique identifier for an instance of an object.

 

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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	Transaction_LogObjectID	[0..*]	Contains a unique identifier for an instance of an object.

Contains a unique identifier for an instance of an object.

 

Parameter name	Type/Value	Cardinality	Description	Validations
#text	string
@type	WID, Background_Check_ID, Budget_Amendment_ID, Customer_Request_ID, Customer_Request_Reference_ID, IRS_1099_MISC_Adjustment_ID, Position_Budget_Group_ID, Procurement_Mass_Close_ID, Procurement_Roll_Forward_ID, Receipt_Number, Request_Leave_of_Absence_ID, Spend_Authorization_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Contract_ID, Workday_Project_ID, Worker_Time_Card_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".

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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_PlanObjectID	[0..*]	Contains a unique identifier for an instance of an object.

Contains a unique identifier for an instance of an object.

 

Parameter name	Type/Value	Cardinality	Description	Validations
#text	string
@type	WID, Additional_Benefits_Plan_ID, Defined_Contribution_Plan_ID, Health_Care_Coverage_Plan_ID, Health_Savings_Account_Plan_ID, Insurance_Coverage_Plan_ID, Spending_Account_Plan_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".

Field Result Request Criteria

 

Parameter name	Type/Value	Cardinality	Description	Validations
Provider_Reference	External_Field_and_Parameter_Initialization_ProviderObject	[1..*]	Field And Parameter Initialization Provider Reference

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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	External_Field_and_Parameter_Initialization_ProviderObjectID	[0..*]	Contains a unique identifier for an instance of an object.

Contains a unique identifier for an instance of an object.

 

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

National Id request criteria.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Identifier_ID	string	[1..1]	The specific national ID value for the worker.
National_ID_Type_Reference [Choice]	National_ID_TypeObject	[1..1]	The type of national id for the worker. Either the type or the country need to be included.
Country_Reference [Choice]	CountryObject	[1..1]	The Country Reference for the National ID. You must enter either the National ID Type or the Country for the National ID. Using the National ID Type is more explicit -if a country is entered, then it is possible that there are multiple workers who have the same ID value but with different national id types within that country.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.

 

Parameter name	Type/Value	Cardinality	Description	Validations
As_Of_Effective_Date	date	[0..1]	Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.
As_Of_Entry_DateTime	dateTime	[0..1]	Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.
Page	decimal (12, 0) >0	[0..1]	Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.
Count	decimal (3, 0) >0	[0..1]	Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.

Validation Description Page Number cannot be zero.  Page number cannot be zero.

Use the response group to limit the response to the data you are interested in. If the request does not set any values for the response group, then the response by default returns the following elements: Reference, Personal Data, Employment Data, Compensation Data, Organization Data, and Role Data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Include_Reference	boolean	[0..1]	Indicates if the Reference element for the worker is included in the response.
Include_Personal_Information	boolean	[0..1]	Indicates if the Personal Data element is included in the response.
Include_Employment_Information	boolean	[0..1]	Indicates if the Employment Data element is included in the response.
Include_Compensation	boolean	[0..1]	Indicates if the Compensation Data element is included in the response.
Include_Organizations	boolean	[0..1]	Indicates if the Organization Data element is included in the response.
Exclude_Organization_Support_Role_Data	boolean	[0..1]	Excludes the supporting role information from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Location_Hierarchies	boolean	[0..1]	Excludes the location hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Cost_Centers	boolean	[0..1]	Excludes the cost centers from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Cost_Center_Hierarchies	boolean	[0..1]	Excludes the cost center hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Companies	boolean	[0..1]	Excludes the company organizations from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Company_Hierarchies	boolean	[0..1]	Excludes the company hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Matrix_Organizations	boolean	[0..1]	Excludes the matrix organizations from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Pay_Groups	boolean	[0..1]	Excludes the pay groups from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Regions	boolean	[0..1]	Excludes the regions from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Region_Hierarchies	boolean	[0..1]	Excludes the region hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Supervisory_Organizations	boolean	[0..1]	Excludes the supervisory organizations from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Teams	boolean	[0..1]	Excludes the teams from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Custom_Organizations	boolean	[0..1]	Excludes the custom organizations from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Include_Roles	boolean	[0..1]	Indicates if the Role Data element is included in the response.
Include_Management_Chain_Data	boolean	[0..1]	Indicates if the Management Chain Data element is included in the response.
Include_Benefit_Enrollments	boolean	[0..1]	Indicates if the Benefit Enrollment Data element is included in the response.
Include_Benefit_Eligibility	boolean	[0..1]	Includes Benefit Eligibility Data
Include_Related_Persons	boolean	[0..1]	Indicates if the Related Person Data element is included in the response.
Include_Qualifications	boolean	[0..1]	Indicates if the Qualification Data element is included in the response.
Include_Employee_Review	boolean	[0..1]	Indicates if the Employee Review Data element is included in the response.
Include_Goals	boolean	[0..1]	Indicates that Goal Details will be included in the web service response.
Include_Development_Items	boolean	[0..1]	Indicates that Development Item Details will be included in the web service response.
Include_Skills	boolean	[0..1]	Indicates that Skill Details will be included in the web service response.
Include_Photo	boolean	[0..1]	Indicates if the Photo Data element is included in the response.
Include_Worker_Documents	boolean	[0..1]	Indicates if the Worker Document Data element is included in the response.
Include_Transaction_Log_Data	boolean	[0..1]	Indicates if the Transaction Log Data element is included in the response.
Include_Succession_Profile	boolean	[0..1]	Indicates if the Succession Profile element is included in the response.
Include_Talent_Assessment	boolean	[0..1]	Indicates if the Talent Assessment element is included in the response.
Include_Employee_Contract_Data	boolean	[0..1]	Indicates if the Employee Contract element is included in the response.
Include_Feedback_Received	boolean	[0..1]	Indicates that Feedback Received will be included in the web service response.
Include_User_Account	boolean	[0..1]	Indicates that User Account Data will be included in the web service response.
Include_Career	boolean	[0..1]	Indicates that Career Data will be included in the web service response.
Include_Account_Provisioning	boolean	[0..1]	Indicates that Account Provisioning Data will be included in the web service response.
Include_Background_Check_Data	boolean	[0..1]	Indicates if the Background Check Data element is included in the response.
Include_Contingent_Worker_Tax_Authority_Form_Information	boolean	[0..1]	Indicates if the Contingent Worker Tax Authority Form Information Data element is included in the response.
Exclude_Funds	boolean	[0..1]	Excludes the Funds from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected
Exclude_Fund_Hierarchies	boolean	[0..1]	Excludes the fund hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Grants	boolean	[0..1]	Excludes the Grants from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected
Exclude_Grant_Hierarchies	boolean	[0..1]	Excludes the grant hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Business_Units	boolean	[0..1]	Excludes the Business Units from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected
Exclude_Business_Unit_Hierarchies	boolean	[0..1]	Excludes the business unit hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Programs	boolean	[0..1]	Excludes the Programs from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected
Exclude_Program_Hierarchies	boolean	[0..1]	Excludes the program hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.
Exclude_Gifts	boolean	[0..1]	Excludes the Gifts from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected
Exclude_Gift_Hierarchies	boolean	[0..1]	Excludes the gift hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.

The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Total_Results	decimal (12, 0) >0	[0..1]	The total number of results that have been returned from your request.
Total_Pages	decimal (12, 0) >0	[0..1]	The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.
Page_Results	decimal (12, 0) >0	[0..1]	Number of Results in current page.
Page	decimal (12, 0) >0	[0..1]	The page of data that has been returned for the given request.

Contains each Worker based on the Request References or Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the worker.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Worker	Worker	[0..*]	Encapsulating element containing all Worker Profile data.

Encapsulating element containing all Worker Profile data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Worker_Reference	WorkerObject	[0..1]	A reference to the ID of the worker. The ID consists of a type attribute, which should be set to "Employee_ID" or "Contingent_Worker_ID", and a value attribute, such as "04345".
Worker_Data	Worker_Data	[0..1]	Contains the detailed information about a worker.

Contains the detailed information about a worker.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Worker_ID	string	[0..1]	The ID for the employee or contingent worker.
User_ID	string	[0..1]	Text attribute identifying User Name.
Personal_Data	Personal_Information_Data	[0..1]	Personal Data	Validation Description The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position  The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position  The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  Usage Type is Invalid for this Contactable.  Usage Type is Invalid for this Contactable.  The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Native Region is only tracked in China.  Native Region is only tracked in China.  Hukou Type is only tracked in China.  Hukou Type is only tracked in China.  Hukou Locality is only tracked for China.  Hukou Locality is only tracked for China.  Hukou Region is only tracked for China.  Hukou Region is only tracked for China.  Hukou Subregion is only tracked in China.  Hukou Subregion is only tracked in China.  The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  You may only specify one ethnicity for this worker or applicant. This is defined by your system administrator and based on the country of the worker or applicant.    Hukou Postal Code is only tracked for China.  Hukou Postal Code is only tracked for China.  Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Last Medical Exam Valid To Date must be after Last Medical Exam Date  Last Medical Exam Valid To Date must be after Last Medical Exam Date  Last Medical Exam Date cannot be in the future  Last Medical Exam Date cannot be in the future  The field Marital Status is required and must have a value if a Marital Status Date is entered.  The field Marital Status is required and must have a value if a Marital Status Date is entered.  The political affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Political Affiliation values are ignored for Puts involving applicants since a Political Affiliation value is associated with workers and not applicants.  The political affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Political Affiliation values are ignored for Puts involving applicants since a Political Affiliation value is associated with workers and not applicants.  The social benefits locality data has not been activated for this location via the Maintain Localization Settings task.  The social benefits locality data has not been activated for this location via the Maintain Localization Settings task.  The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.  The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.
Employment_Data	Worker_Employment_Information_Data	[0..1]	Contains the worker's employment information, such as their position and job information. Security Note: This element is secured to the following domains: Self-Service: Current Staffing Information, Worker Data: Current Staffing Information
Compensation_Data	Worker_Compensation_Data	[0..1]	Compensation Data
Organization_Data	Worker_Organization_Data	[0..1]	Organization Data
Role_Data	Worker_Role_Data	[0..1]	Role Data
Management_Chain_Data	Worker_Management_Chain_Data	[0..1]	Management Chain Data
Benefit_Enrollment_Data	Worker_Benefit_Enrollment_Data	[0..1]	Contains the worker's benefits information. Security Note: This element is secured to the following domains: Self Service: Benefit Elections; Worker Data: Benefit Elections
Benefit_Eligibility_Data	Worker_Benefit_Eligibility_Data	[0..1]	Contains the worker's benefit eligibility information for all Benefit Plan criteria that is not in the current plan year definition.
Related_Person_Data	Worker_Related_Persons_Data	[0..1]	Contains the person's that are related to the worker as a dependent, beneficiary or emergency contact. Security Note: This element is secured to the following domains: Self Service: Benefit Elections; Worker Data: Benefit Elections
Qualification_Data	Person_Qualification_Data	[0..1]	Qualification Data
Employee_Review_Data	Employee_Review_Data	[0..1]	Contains the employee's latest review for performance, performance improvement plan, development plan, and disciplinary action. This is only valid for a worker than is an employee. Security Note: This element is secured to the following domains: Worker Data: Employee Reviews, Self Service: Employee Reviews
Photo_Data	Employee_Image_Data	[0..1]	Contains a photo of the worker. Security Note: This element is not secured so anyone that can run this web service has access to this element.
Worker_Document_Data	Worker_Document_Data_WWS	[0..1]	Contains the documents that were added for a worker during staffing events or ad-hoc. Security Note: This element is not secured so anyone that can run this web service has access to this element.
Integration_Field_Override_Data	Document_Field_Result_Data	[0..*]	Worker External Field Result Data
Transaction_Log_Entry_Data	Event_Target_Transaction_Log_Entry_Data	[0..1]	Transaction Log Entry Data
Transaction_Log_Corrected_And_Rescinded_Data	Event_Target_Transaction_Log_Rescind_And_Correct_Data	[0..*]	Encapsulating element containing transaction log entries that have been rescinded or corrected.
Succession_Profile_Data	Succession_Profile_Data	[0..1]	Contains a list of positions for which the employee is a succession candidate. This is only valid for a worker than is an employee. Security Note: This element is secured to the following domain: Worker Data: Succession.
Talent_Assessment_Data	Talent_Assessment_Data	[0..1]	Contains the employee's latest talent assessment, such as potential, achievable level, and retention. This is only valid for a worker than is an employee. Security Note: This element is secured to the following domain: Worker Data: Talent.
Worker_Goal_Data	Worker_Goal_Data	[0..1]	Contains the employee's goals and is similar to the content that is found in the Employee Goals UI page for an employee. Security Note: This element is secured to the following domain: Worker Data: Employee Goals
Development_Item_Data	Worker_Development_Item_Data	[0..1]	Contains the employee's development items and is similar to the content that is found in the Development Items UI page for an employee.
Skill_Data	Worker_Skill_Item_Data	[0..1]	Creates all Skills for the referenced Worker
Employee_Contracts_Data	Employee_Contracts_Data	[0..1]	Contains the employee's contract information.
Feedback_Received_Data	Feedback_Received_Data	[0..1]	Contains the employee's feedback received
User_Account_Data	System_User_for_Worker_Data	[0..1]	Contains the worker's user account information (user name, preferred language).
Career_Data	Worker_Career_Data	[0..1]	Contains the current career information for an employee. This includes the travel and relocation preferences, job profiles the employee is interested in, and their career interests
Account_Provisioning_Data	Person_Account_Provisioning_Data	[0..1]	Contains the worker's provisioning group assignments
Background_Check_Data	Background_Check_Data	[0..*]	Contains Background Check Information	Validation Description Background check status ([status]) is not valid.
Contingent_Worker_Tax_Authority_Form_Type_Data	Contingent_Worker_Tax_Authority_Form_Information_Data	[0..*]	Contingent Worker Tax Authority Form Information

Wrapper element for Personal Data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Name_Data	Person_Name_Data	[0..1]	Contains the legal, preferred, and additional names for a person.
Gender_Reference	GenderObject	[0..1]	Describes the sex of the person based on representation of human sexes. Security Note: This element is secured according to the security policy for the "Gender/Age/Marital Status for Worker" domain.
Birth_Date	date	[0..1]	A person's birth date. Security Note: This element is secured according to the security policy for the "Gender/Age/Marital Status for Worker" domain.
Date_of_Death	date	[0..1]	The date of a person's death. The date of death element is not valid for the following web services and will be ignored: Hire Employee, Contract Contingent Worker, and Put Applicant. Security Note: This element is secured according to the security policy for the "Gender/Age/Marital Status for Worker" domain.
Country_of_Birth_Reference	CountryObject	[0..1]	The country the person was born in. Security Note: This element is secured according to the security policy for the "Ethnicity/Disability/Religion/Country of Birth for Worker" domain.
Region_of_Birth_Reference	Country_RegionObject	[0..1]	The country region the person was born in. Security Note: This element is secured according to the security policy for the "Ethnicity/Disability/Religion/Country of Birth for Worker" domain.
City_of_Birth	string	[0..1]	The city the person was born in. Security Note: This element is secured according to the security policy for the "Ethnicity/Disability/Religion/Country of Birth for Worker" domain.
Marital_Status_Reference	Marital_StatusObject	[0..1]	Indicates the marital status that a person has. Security Note: This element is secured according to the security policy for the "Worker Data: Gender/Age/Marital Status" domain.
Marital_Status_Date	date	[0..1]	The person's marital status date.	Validation Description The Marital Status Date cannot be before the Date of Birth  The Marital Status Date cannot be before the Date of Birth
Religion_Reference	ReligionObject	[0..1]	Indicates the religions that a person has. Security Note: This element is secured according to the security policy for the "Ethnicity/Disability/Religion/Country of Birth for Worker" domain.
Disability_Status_Data	Person_Disability_Status_Data	[0..*]	Disability Status Data for a Person Security Note: This element is secured according to the security policy for the Worker Data: Disabilities domain.	Validation Description The worker's location context is not enabled for Disability Grade.    The provided Disability Grade is not valid for the worker's location context or is inactive.    The worker's location context is not enabled for Disability Degree.    The worker's location context is not enabled for Disability Remaining Capacity.    The worker's location context is configured to use Disability Authority Reference.    The provided Disability Authority is not valid for the worker's location context or is inactive.    The worker's location context is not enabled for Disability Authority.    The provided Disability Authority Reference is not valid or inactive for the worker's location context. Or the worker's location context is not enabled for Disability Authority.    The worker's location is not enabled for Disability Certification Location.    The worker's location context is not enabled for Disability Certification ID.    The worker's location context is not enabled for Disability Certification Basis.    The provided Disability Certification Basis is not valid for the worker's location context or is inactive.    The worker's location context is not enabled for Disability Severity Recognition Date.    The worker's location context is not enabled for Disability FTE Toward Quota.    The provided Disability is not valid for the worker's location context. The location context is derived from the country of the location specified for the position.
Ethnicity_Reference	EthnicityObject	[0..*]	Indicates the ethnicities that a person has. Security Note: This element is secured according to the security policy for the "Ethnicity/Disability/Religion/Country of Birth for Worker" domain.
Hispanic_or_Latino	boolean	[0..1]	Returns a true if the person's ethnicity is Hispanic or Latino. Security Note: This element is secured according to the security policy for the "Ethnicity/Disability/Religion/Country of Birth for Worker" domain.
Citizenship_Status_Reference	Citizenship_StatusObject	[0..*]	Specifies the status of a person's legal citizenship. Security Note: This element is secured according to the security policy for the "Military/Citizenship for Worker" domain.
Nationality_Reference	CountryObject	[0..1]	Specifies the person's Country of Nationality. Security Note: This element is secured according to the security policy for the "Military/Citizenship for Worker" domain.
Hukou_Region_Reference	Country_RegionObject	[0..1]	The hukou region for the person. Security Note: This element is secured according to the security policy for the "Military/Citizenship" domain.
Hukou_Subregion_Reference	Country_SubregionObject	[0..1]	The hukou subregion for the person. Security Note: This element is secured according to the security policy for the "Military/Citizenship" domain.
Hukou_Locality	string	[0..1]	The hukou locality for the person. Security Note: This element is secured according to the security policy for the "Military/Citizenship" domain.
Hukou_Postal_Code	string	[0..1]	The hukou postal code for the person. Security Note: This element is secured according to the security
Hukou_Type_Reference	Hukou_TypeObject	[0..1]	The hukou type for the person. Security Note: This element is secured according to the security policy for the "Military/Citizenship" domain.
Local_Hukou	boolean	[0..1]	Whether the hukou subregion of the person is local to the location of the primary job. This field is only used in a response and is not used for requests. Security Note: This element is secured according to the security policy for the "Military/Citizenship" domain.
Native_Region_Reference	Country_RegionObject	[0..1]	The native region for the person. Security Note: This element is secured according to the security policy for the "Military/Citizenship" domain.
Personnel_File_Agency_for_Person	string	[0..1]	Personnel File Agency is used in China to indicate where workers have their personnel file stored.
Last_Medical_Exam_Date	date	[0..1]	This field tracks the date of the worker's most recent medical exam
Last_Medical_Exam_Valid_To	date	[0..1]	This field tracks the expiration date of the worker's most recent medical exam
Medical_Exam_Notes	string	[0..1]	This field tracks any comments regarding the worker's most recent medical exam
Military_Service_Data	Person_Military_Service_Data	[0..*]	Returns the military status for a person. Security Note: This element is secured according to the security policy for the "Military/Citizenship for Worker" domain.	Validation Description The Military Rank specified is not valid for Military Service Type or Country from Military Status.  The Military Rank specified is not valid for Military Service Type or Country from Military Status.  The Military Service Type specified is not valid for Country from Military Status.  The Military Service Type specified is not valid for Country from Military Status.
Identification_Data	Person_Identification_Data	[0..1]	The id information for the person (national ids, government ids, passport ids, visa ids, license ids, custom ids). Security Note: This is secured to the following domains: My ID Information, Worker ID Information, Applicant Personal Data: ID Information
Contact_Data	Contact_Information_Data	[0..1]	All of the person's contact data (address, phone, email, instant messenger, web address). Security Note: The response for Contact information is secured to the My Contact Information and Worker Private Contact Information domains for Get Workers and Get Payees and secured to the Applicant Data: Contact Information domain for Get Applicants web service.	Validation Description One and only one work 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 business address must be marked as primary.  One and only one business 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.
Tobacco_Use	boolean	[0..1]	Returns a true if the person uses tobacco products.
Political_Affiliation_Reference	Political_AffiliationObject	[0..1]	This field tracks the political affiliation of the person.
Social_Benefits_Locality_Reference	Social_Benefits_LocalityObject	[0..1]	The person's Social Benefits Locality. Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.

Validation Description The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position  The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position  The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  Usage Type is Invalid for this Contactable.  Usage Type is Invalid for this Contactable.  The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Native Region is only tracked in China.  Native Region is only tracked in China.  Hukou Type is only tracked in China.  Hukou Type is only tracked in China.  Hukou Locality is only tracked for China.  Hukou Locality is only tracked for China.  Hukou Region is only tracked for China.  Hukou Region is only tracked for China.  Hukou Subregion is only tracked in China.  Hukou Subregion is only tracked in China.  The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  You may only specify one ethnicity for this worker or applicant. This is defined by your system administrator and based on the country of the worker or applicant.    Hukou Postal Code is only tracked for China.  Hukou Postal Code is only tracked for China.  Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Last Medical Exam Valid To Date must be after Last Medical Exam Date  Last Medical Exam Valid To Date must be after Last Medical Exam Date  Last Medical Exam Date cannot be in the future  Last Medical Exam Date cannot be in the future  The field Marital Status is required and must have a value if a Marital Status Date is entered.  The field Marital Status is required and must have a value if a Marital Status Date is entered.  The political affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Political Affiliation values are ignored for Puts involving applicants since a Political Affiliation value is associated with workers and not applicants.  The political affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Political Affiliation values are ignored for Puts involving applicants since a Political Affiliation value is associated with workers and not applicants.  The social benefits locality data has not been activated for this location via the Maintain Localization Settings task.  The social benefits locality data has not been activated for this location via the Maintain Localization Settings task.  The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.  The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.

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.

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.

Contains the components of a name, such as the First Name and Last Name.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Formatted_Name	string	[0..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	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

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	[0..1]	Contains the formatted local name in local script as configured for the country.
@Local_Script	string	[0..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.

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

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.

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.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

Wrapper element for the disability status information for the person.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Disability_Reference	DisabilityObject	[1..1]	The person's disability
Disability_Status_Date	date	[0..1]	This person's disability status date	Validation Description The Disability Status Date cannot be before the Date of Birth  The Disability Status Date cannot be before the Date of Birth  The element Disability Reference is required if a Disability Status Date is entered.  The element Disability Reference is required if a Disability Status Date is entered.
Disability_Date_Known	date	[0..1]	The date you (the employer) first learned about the disability.	Validation Description The Disability Date Known cannot be before the Date of Birth.
Disability_End_Date	date	[0..1]	The date through which the worker is considered disabled. In some countries, this is the date through which the certification for the current level of disability is effective.	Validation Description The Disability End Date cannot be before the Date of Birth.
Disability_Grade_Reference	Disability_GradeObject	[0..1]	A code or number that identifies the level of disability.
Disability_Degree	decimal (8, 2) >0	[0..1]	A percentage that identifies the worker's level of disability as of the disability date.
Disability_Remaining_Capacity	decimal (8, 2) >0	[0..1]	The percentage of that the person may work per labor physician or other authority.
Disability_Certification_Authority_Reference [Choice]	Disability_Certification_AuthorityObject	[0..1]	The name of the person or agency that certified the disability.
Disability_Certification_Authority [Choice]	string	[0..1]	The name of the person or agency that certified the disability.
Disability_Certified_At	string	[0..1]	The place where the person or agency certified the disability.
Disability_Certification_ID	string	[0..1]	The ID provided to the worker, if any.
Disability_Certification_Basis_Reference	Disability_Certification_BasisObject	[0..1]	How the worker qualified for the certification.
Disability_Severity_Recognition_Date	date	[0..1]	The date the disability was recognized as severe by the recognizing authority.	Validation Description The Disability Severity Recognition Date cannot be before the Date of Birth.
Disability_FTE_Toward_Quota	decimal (13, 1) >0	[0..1]	The FTE that counts towards the employer's quota for hiring the disabled.
Disability_Work_Restrictions	string	[0..1]	List any work restrictions that apply to the worker.
Disability_Accommodations_Requested	string	[0..1]	Describe any accommodations requested by the worker or their care provider.
Disability_Accommodations_Provided	string	[0..1]	Describe any accommodations provided by you, the employer.
Disability_Rehabilitation_Requested	string	[0..1]	Describe any rehabilitation measures requested by the worker or their care provider.
Disability_Rehabilitation_Provided	string	[0..1]	Describe any rehabilitation measures provided by you, the employer.
Note	string	[0..1]	Enter any additional information related to this disability.
Worker_Document_Reference	Worker_DocumentObject	[0..*]	Attach a copy of the certification or other documents related to this instance of disability.
Disability_Status_Reference	Disability_Status_ReferenceObject	[0..1]	Reference ID for the Disability Status

Validation Description The worker's location context is not enabled for Disability Grade.    The provided Disability Grade is not valid for the worker's location context or is inactive.    The worker's location context is not enabled for Disability Degree.    The worker's location context is not enabled for Disability Remaining Capacity.    The worker's location context is configured to use Disability Authority Reference.    The provided Disability Authority is not valid for the worker's location context or is inactive.    The worker's location context is not enabled for Disability Authority.    The provided Disability Authority Reference is not valid or inactive for the worker's location context. Or the worker's location context is not enabled for Disability Authority.    The worker's location is not enabled for Disability Certification Location.    The worker's location context is not enabled for Disability Certification ID.    The worker's location context is not enabled for Disability Certification Basis.    The provided Disability Certification Basis is not valid for the worker's location context or is inactive.    The worker's location context is not enabled for Disability Severity Recognition Date.    The worker's location context is not enabled for Disability FTE Toward Quota.    The provided Disability is not valid for the worker's location context. The location context is derived from the country of the location specified for the position.

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

Parameter name	Type/Value	Cardinality	Description	Validations
#text	string
@type	WID, File_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".

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

Wrapper element for the military service information for the person.

 

Parameter name	Type/Value	Cardinality	Description	Validations
Status_Reference	Military_StatusObject	[1..1]	The person's military status.	Validation Description Inactive military statuses are not allowed in this request.  Inactive military statuses are not allowed in this request.
Discharge_Date	date	[0..1]	The date the person was discharged from the military.
Status_Begin_Date	date	[0..1]	Begin Date for military service status
Military_Service_Type_Reference	Military_Service_TypeObject	[0..1]	Service type for military service
Military_Rank_Reference	Military_RankObject	[0..1]	Military rank for military service type
Notes	RichText	[0..1]	Notes for military service
Military_Service_Reference	Military_Service_ReferenceObject	[0..1]	Reference ID for the Military Service

Validation Description The Military Rank specified is not valid for Military Service Type or Country from Military Status.  The Military Rank specified is not valid for Military Service Type or Country from Military Status.  The Military Service Type specified is not valid for Country from Military Status.  The Military Service Type specified is not valid for Country from Military Status.

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

 

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

Contains a unique identifier for an instance of an object.

 

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

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.

Wrapper element for all National Identifier Data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Delete	boolean	[0..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.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

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.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

Encapsulating element for all Government Identifier data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Delete	boolean	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

Encapsulating element for all Visa Identifier data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Delete	boolean	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

Encapsulating element for all Passport Identifier data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Delete	boolean	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

Encapsulating element for all License Identifier data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Delete	boolean	[0..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.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

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.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

Encapsulating element for all Custom Identifier data.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Delete	boolean	[0..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.

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.

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Descriptor	string	[0..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.

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

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.
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 business address must be marked as primary.  One and only one business 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.

Address information

 

Parameter name	Type/Value	Cardinality	Description	Validations
@Formatted_Address	string	[0..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	[0..1]	The format type of the address.
@Defaulted_Business_Site_Address	boolean	[0..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	[0..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	[0..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	[0..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.

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	[0..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	[0..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.

The submunicipality of the address.

 

Parameter name	Type/Value	Cardinality	Description	Validations
#text	string
@Address_Component_Name	string	[0..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	[0..1]	The city subdivision part of the address.

The subregion part of the address.

 

Parameter name	Type/Value	Cardinality	Description	Validations
#text	string
@Descriptor	string	[0..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	[0..1]	Enter the Region Subdivision Type, such as REGION_SUBDIVISION_1, or REGION_SUBDIVISION_2.