Service Directory > v32.1 > Human_Resources > Add_Academic_Appointment
 

Operation: Add_Academic_Appointment

This operation will invoke the Business Process to add an Academic Appointment.


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


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Add_Academic_Appointment_Request

Top-level request element to add an academic appointment
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Add_Academic_Appointment_Data  Add_Academic_Appointment_Data  [1..1]  Add Academic Appointment Request Wrapper for the Add Academic Appointment Web Service 
Validation Description
Reference ID for Academic Affiliate already in use.   
The Manage Education Sub Business Process element is only valid for Academic Affiliates without Education Details   
The Create Workday Account Sub Business Process element is only valid for Academic Affiliate without a Workday Account.   
The Manage Professional Affiliation Sub Business Process element is only valid for new Academic Affiliates   
The Academic Appointee Reference or Create Academic Affiliate Data is a Required field   
Mark Add Academic Affiliate Status false or leave it blank when add appointment is for a student.   
Mark Add Academic Affiliate Status false or leave it blank when add appointment is for an affiliate.   
Leave the Add Academic Affiliate Status field blank or select False for terminated workers who didn't have an academic appointment.   
 
top
 

Response Element: Academic_Appointment_Response

Top-level response element for Academic Appointment business process operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Unique_IdentifierObject  [0..1]  Reference to the Academic Appointment business process.   
Academic_Appointee_Reference  Academic_Appointee_EnabledObject  [0..1]  Academic Appointee Reference relating to Appointment Business Process   
Academic_Appointment_Track_Reference  Academic_Appointment_TrackObject  [0..1]  Reference to the Academic Appointment Track that the business process applies to.   
top
 

Business_Process_Parameters

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

Business_Process_Comment_Data

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

WorkerObject

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

WorkerObjectID

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

Business_Process_Attachment_Data

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

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Add_Academic_Appointment_Data

part of: Add_Academic_Appointment_Request
Wrapper element for the Add Academic Appointment business process.
 
Parameter name Type/Value Cardinality Description Validations
Reason_Reference  General_Event_SubcategoryObject  [1..1]  Reference ID for the reason for the academic appointment event.   
Add_Academic_Affiliate_Status  boolean  [0..1]  Flag to Add Academic Affiliate Status to Worker 
Validation Description
Complete all other in progress add academic appointment events for this person before submitting this web service.   
 
Academic_Appointee_Reference [Choice]   Academic_Appointee_EnabledObject  [0..1]  Reference ID for the person this academic appointment is for. 
Validation Description
The appointee isn’t allowed when processing their appointment as a sub-process.   
An employment position is not allowed when processing an appointment for the appointee.   
Add Academic Appointment is not allowed for student prospects.   
Add Academic Appointment is not allowed for unsolicited prospects.   
Add Academic Appointment is not allowed for inactive students.   
 
Create_Academic_Affiliate_Data [Choice]   Create_Academic_Affiliate_Data  [0..1]  Data for a new Academic Affiliate if an affiliate is to be created as part of the appointment.   
Academic_Appointment_Data  Academic_Appointment_Snapshot_Data  [1..1]  Element containing the specifics for the academic appointment being added or updated. An academic appointment tracks an academic worker’s time at a university or college. 
Validation Description
Update Date must be prior to the Academic Appointment End Date   
The key Reference ID for the Academic Appointment Track/Thread is required for an Update Academic Appointment request.   
Appointment Tracks with an In-Progress event cannot be updated or ended until the In-Progress event is completed or cancelled   
 
Create_Workday_Account_Sub_Business_Process_for_Academic_Affiliate  Create_Workday_Account_Sub_Business_Process  [0..1]  Wrapper to hold the business process configuration and user account details. 
Validation Description
The Create Workday Account Data element is required if Automatically Complete is True.   
 
Manage_Professional_Affiliation_Sub_Business_Process_for_Academic_Affiliate  Manage_Professional_Affiliation_Sub_Business_Process_Data  [0..*]  Manage Professional Affiliation Sub Business Process Data 
Validation Description
The "Manage Professional Affiliation Data" subelement is required if "Automatically Complete" is set to true.  The "Manage Professional Affiliation Data" subelement is required if "Automatically Complete" is set to true. 
 
Manage_Education_Sub_Business_Process_for_Academic_Affiliate  Manage_Education_Sub_Business_Process_Data  [0..*]  Manage Education Sub Business Process Data 
Validation Description
The "Manage Education Data" subelement is required if "Automatically Complete" is set to true.  The "Manage Education Data" subelement is required if "Automatically Complete" is set to true. 
 
Manage_Instructor_Eligibility_Sub_Business_Process_for_Academic_Affiliate  Manage_Instructor_Eligibility_Sub_Business_Process_Data  [0..*]  Manage Instructor Eligibility Sub Business Process Data   
Validation Description
Reference ID for Academic Affiliate already in use.   
The Manage Education Sub Business Process element is only valid for Academic Affiliates without Education Details   
The Create Workday Account Sub Business Process element is only valid for Academic Affiliate without a Workday Account.   
The Manage Professional Affiliation Sub Business Process element is only valid for new Academic Affiliates   
The Academic Appointee Reference or Create Academic Affiliate Data is a Required field   
Mark Add Academic Affiliate Status false or leave it blank when add appointment is for a student.   
Mark Add Academic Affiliate Status false or leave it blank when add appointment is for an affiliate.   
Leave the Add Academic Affiliate Status field blank or select False for terminated workers who didn't have an academic appointment.   
top
 

General_Event_SubcategoryObject

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

General_Event_SubcategoryObjectID

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

Academic_Appointee_EnabledObject

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

Academic_Appointee_EnabledObjectID

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

Create_Academic_Affiliate_Data

part of: Add_Academic_Appointment_Data
Data for a new Academic Affiliate if an affiliate is to be created as part of the appointment.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the academic affiliate.   
Person_Name_Data  Person_Name_Data  [0..1]  Contains the components of a name, such as the First Name and Last Name.   
Contact_Information_Data  Contact_Information_Data  [0..1]  All of the person's contact data (address, phone, email, instant messenger, web address). 
Validation Description
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request.  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request. 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
One and only one Institutional email address must be marked as primary.  One and only one Institutional email address must be marked as primary. 
One and only one Institutional phone must be marked as primary.  One and only one Institutional phone must be marked as primary. 
One and only one Institutional address must be marked as primary.  One and only one Institutional address must be marked as primary. 
One and only one Institutional instant messenger address must be marked as primary.  One and only one Institutional instant messenger address must be marked as primary. 
One and only one Institutional web address must be marked as primary.  One and only one Institutional web address must be marked as primary. 
Only one address of type International Assignment is allowed for a country.  Only one address of type International Assignment is allowed for a country. 
Only one address of type work from home is allowed.  Only one address of type work from home is allowed. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
At least one Primary Email must be specified in order to add an Additional Email  At least one Primary Email must be specified in order to add an Additional Email 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
At least one Primary Phone must be specified in order to add an Additional Phone  At least one Primary Phone must be specified in order to add an Additional Phone 
Either a phone number, or an email address must be specified for an emergency contact.  Either a phone number, or an email address must be specified for an emergency contact. 
Primary address on Ship-To location must have a use of [Shipping]  Primary address on Ship-To location must have a use of that maps to Shipping. 
 
Personal_Information_Data  Generic_Personal_Information_Data  [0..1]  Encapsulating element containing all Personal Information for a new Academic Affiliate.   
Person_Identification_Data  Person_Identification_Data  [0..1]  Wrapper for Person Identification Data. Includes National Identifiers, Government Identifiers, Visa Identifiers, Passport Identifiers, License Identifiers and Custom Identifiers.   
Person_Photo_Data  Person_Photo_Data  [0..1]  Person's Photo Information   
Location_Contexts_Reference  Location_ContextObject  [0..*]  Reference to the location context for the Affiliate. Auto-populated from the country from the person's legal name.   
top
 

Person_Name_Data

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

Legal_Name_Data

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

Person_Name_Detail_Data

part of: Legal_Name_Data, Preferred_Name_Data, Additional_Name_Data
Contains the components of a name, such as the First Name and Last Name.
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Name  string  [1..1]  Contains a fully formatted name in one string that has all of its pieces in their proper place. This name is only used in a response and is not used for requests   
@Reporting_Name  string  [1..1]  Contains a fully formatted name in one string for reporting that has all of its pieces in their proper place. This name is only used in a response and is not used for request   
Country_Reference  CountryObject  [1..1]  The Country that the name is in reference to. 
Validation Description
If one local script is submitted, all required local script name fields must be submitted.   
If one western script is submitted, all required western script name fields must be submitted.   
Local name is not enabled for this country.   
 
Prefix_Data  Person_Name_Prefix_Data  [0..1]  Contains the prefixes for a name.   
First_Name  string  [0..1]  The First Name (Given Name) for a person. 
Validation Description
First Name is not setup for this country.   
First Name (or Local First Name if configured) is required for this country.   
The First Name field accepts only Western script.   
 
Middle_Name  string  [0..1]  The Middle Name for a person. 
Validation Description
Middle Name is not setup for this country.   
Middle Name (or Local Middle Name if configured) is required for this country.   
 
Last_Name  string  [0..1]  The Last Name (Family Name) for a person. 
Validation Description
Last Name is not set up for this country.   
Last Name (or Local Last Name if configured) is required for this country.   
The Last Name field accepts only Western script.   
 
Secondary_Last_Name  string  [0..1]  The Secondary Last Name (Secondary Family Name) for a person. 
Validation Description
Secondary Last Name (or Local Secondary Last Name) is required for this country.   
Last Name - Secondary is not set up for this country.   
 
Tertiary_Last_Name  string  [0..1]  The Tertiary Last Name for a person. 
Validation Description
Last Name - Tertiary is not set up for this country.   
Tertiary Last Name is required for this country.   
 
Local_Name_Detail_Data  Local_Person_Name_Detail_Data  [0..1]  Contains the name components in local script for supporting countries.   
Suffix_Data  Person_Name_Suffix_Data  [0..1]  Contains the suffixes for a name.   
Full_Name_for_Singapore_and_Malaysia  string  [0..1]  Full Person Name is used by Malaysia and Singapore. It is designed for (eliminate space between these two words) Workers in these countries to enter their Full Legal Name. It is an attribute of Global Person Name Class and is not a concatenation of First and Last Names. 
Validation Description
Full Name is not set up for this country.   
 
top
 

CountryObject

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

CountryObjectID

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

Person_Name_Prefix_Data

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

Country_Predefined_Person_Name_Component_ValueObject

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

Country_Predefined_Person_Name_Component_ValueObjectID

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

Local_Person_Name_Detail_Data

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

Person_Name_Suffix_Data

part of: Person_Name_Detail_Data
Contains the suffixes for a name.
 
Parameter name Type/Value Cardinality Description Validations
Social_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the description of Social Suffix for a person. 
Validation Description
Social Suffix is required for this country.   
Social Suffix is not setup for this country.   
[social suffix] is not a valid social suffix value for [country].   
 
Social_Suffix_Descriptor  string  [0..1]  A reference to the description of Social Suffix for a person.   
Academic_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Academic Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Academic Suffix is required for this country.   
Academic Suffix is not setup for this country.   
[academic suffix] is not a valid academic suffix value for [country].   
 
Hereditary_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Hereditary Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Hereditary Suffix is required for this country.   
Hereditary Suffix is not setup for this country.   
[hereditary suffix] is not a valid hereditary suffix value for [country].   
 
Honorary_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Honorary Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Honorary Suffix is required for this country.   
Honorary Suffix is not setup for this country.   
[honorary suffix] is not a valid honorary suffix value for [country].   
 
Professional_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Professional Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Professional Suffix is required for this country.   
Professional Suffix is not setup for this country.   
[professional suffix] is not a valid professional suffix value for [country].   
 
Religious_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Religious Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Religious Suffix is required for this country.   
Religious Suffix is not setup for this country.   
[religious suffix] is not a valid religious suffix value for [country].   
 
Royal_Suffix_Reference  Country_Predefined_Person_Name_Component_ValueObject  [0..1]  A reference to the Royal Suffix for a person. This is only valid for the country of Australia. 
Validation Description
Royal Suffix is required for this country.   
Royal Suffix is not setup for this country.   
[royal suffix] is not a valid royal suffix value for [country].   
 
top
 

Preferred_Name_Data

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

Additional_Name_Data

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

Additional_Name_TypeObject

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

Additional_Name_TypeObjectID

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

Contact_Information_Data

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

Address_Information_Data

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

Address_Line_Information_Data

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

Country_CityObject

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

Country_CityObjectID

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

Submunicipality_Information_Data

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

Country_RegionObject

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

Country_RegionObjectID

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

Subregion_Information_Data

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

Communication_Method_Usage_Information_Data

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

Communication_Usage_Type_Data

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

Communication_Usage_TypeObject

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

Communication_Usage_TypeObjectID

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

Communication_Usage_BehaviorObject

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

Communication_Usage_BehaviorObjectID

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

Communication_Usage_Behavior_TenantedObject

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

Communication_Usage_Behavior_TenantedObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Phone_Information_Data

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

Phone_Device_TypeObject

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

Phone_Device_TypeObjectID

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

Phone_ReferenceObject

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

Phone_ReferenceObjectID

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

Email_Address_Information_Data

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

Email_ReferenceObject

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

Email_ReferenceObjectID

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

Instant_Messenger_Information_Data

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

Instant_Messenger_TypeObject

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

Instant_Messenger_TypeObjectID

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

Instant_Messenger_ReferenceObject

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

Instant_Messenger_ReferenceObjectID

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

Web_Address_Information_Data

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

Web_Address_ReferenceObject

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

Web_Address_ReferenceObjectID

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

Generic_Personal_Information_Data

part of: Create_Academic_Affiliate_Data
Container for the Personal Information data.
 
Parameter name Type/Value Cardinality Description Validations
Gender_Reference  GenderObject  [0..1]  Reference to the Gender of the person.   
Date_of_Birth  date  [0..1]  Person's Date of Birth. 
Validation Description
Date of birth must precede marital status date, medical exam dates and date of death. This applies to the data in this request as well any existing data on the person that is not being modified.  Date of birth must precede marital status date, medical exam dates and date of death. This applies to the data in this request as well any existing data on the person that is not being modified. 
Date of birth must precede all disability status dates currently on the person unless all disability data is being replaced.  Date of birth must precede all disability status dates currently on the person unless all disability data is being replaced. 
Date of birth must precede all military discharge dates currently on the person unless all military service data is being replaced.  Date of birth must precede all military discharge dates currently on the person unless all military service data is being replaced. 
 
Date_of_Death  date  [0..1]  Person's Date of Death. 
Validation Description
Date of death is only allowed for inactive person.  Date of death is only allowed for inactive person. 
The date of death cannot be in the future  The date of death cannot be in the future 
 
Birth_Country_Reference  CountryObject  [0..1]  Country where the person was born. 
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 
 
Birth_Region_Reference  Country_RegionObject  [0..1]  Country Region where the person was born. 
Validation Description
A Person cannot have a Birth Region without a corresponding Birth Country.  A Person cannot have a Birth Region without a corresponding Birth Country. 
The Region of Birth entered is not valid for the corresponding Country of Birth.  The Region of Birth entered is not valid for the corresponding Country of Birth. 
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. 
 
City_of_Birth  string  [0..1]  Person's City of Birth. 
Validation Description
The city of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The city of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
 
Marital_Status_Reference  Marital_StatusObject  [0..1]  Reference for the person's Marital Status. 
Validation Description
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. 
Inactive marital statuses are not allowed in this request.  Inactive marital statuses are not allowed in this request. 
 
Marital_Status_Date  date  [0..1]  Person's Marital Status Date. 
Validation Description
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. 
 
Ethnicity_Reference  EthnicityObject  [0..*]  Reference for the person's Ethnicities. 
Validation Description
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 
At least one ethnicity in this request is inactive. Only active ethnicities are allowed.  At least one ethnicity in this request is inactive. Only active ethnicities are allowed. 
Multiple Ethnicities are not allowed for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  Multiple Ethnicities are not allowed for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
 
Hispanic_or_Latino  boolean  [0..1]  Boolean to indicate if a person is Hispanic or Latino. 
Validation Description
Hispanic or Latino is only tracked in the USA and must be enabled in tenant setup by your administrator.  Hispanic or Latino is only tracked in the USA and must be enabled in tenant setup by your administrator. 
 
Religion_Reference  ReligionObject  [0..1]  Reference for a person's Religions. 
Validation Description
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. 
 
Citizenship_Reference  Citizenship_StatusObject  [0..*]  Reference for the person's Citizenship Status. 
Validation Description
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. 
At least one citizenship status in this request is inactive. Only active statuses are allowed.  At least one citizenship status in this request is inactive. Only active statuses are allowed. 
Hukou can only be entered for citizens of China.  Hukou can only be entered for citizens of China. 
 
Nationality_Reference  CountryObject  [0..1]  Reference for the person's Country of Nationality 
Validation Description
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. 
 
Hukou_Region_Reference  Country_RegionObject  [0..1]  Country region on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China. 
Validation Description
Hukou Region must be in China.  Hukou Region must be in China. 
The hukou region is not tracked for the specified Location Context.  The hukou region is not tracked for the specified Location Context. 
 
Hukou_Subregion_Reference  Country_SubregionObject  [0..1]  Country subregion on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China. 
Validation Description
The Hukou Subregion does not exist within the specified Hukou Region or is inactive.  The Hukou Subregion does not exist within the specified Hukou Region or is inactive. 
The hukou subregion is not tracked for the specified Location Context.  The hukou subregion is not tracked for the specified Location Context. 
 
Hukou_Locality  string  [0..1]  Locality on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China. 
Validation Description
The hukou locality is not tracked for the specified Location Context.  The hukou locality is not tracked for the specified Location Context. 
 
Hukou_Postal_Code  string  [0..1]  Hukou postal code for the person. This field is only available for the country China and the person with citizenship status of China. 
Validation Description
The hukou postal code is not tracked for the specified Location Context.  The hukou postal code is not tracked for the specified Location Context. 
 
Hukou_Type_Reference  Hukou_TypeObject  [0..1]  Hukou type on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China. 
Validation Description
The hukou type is not tracked for the specified Location Context.  The hukou type is not tracked for the specified Location Context. 
 
Native_Region_Reference  Country_RegionObject  [0..1]  Native region on the Hukou of the person. This field is only available for the country China and the person with citizenship status of China. 
Validation Description
The native region is not tracked for the specified Location Context.  The native region is not tracked for the specified Location Context. 
 
Personnel_File_Agency  string  [0..1]  Personnel File Agency is used in China to indicate where persons have their personnel file stored. 
Validation Description
The Personnel File Agency is not tracked for the specified Location Context.  The Personnel File Agency is not tracked for the specified Location Context. 
 
Political_Affiliation_Reference  Political_AffiliationObject  [0..1]  Person's Political Affiliation. 
Validation Description
The political affiliation does not exist in the specified Location Context.  The political affiliation does not exist in the specified Location Context. 
 
Social_Benefits_Locality_Reference  Social_Benefits_LocalityObject  [0..1]  Person's social benefits locality. 
Validation Description
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. 
 
Last_Medical_Exam_Date  date  [0..1]  Date of person's most recent Medical Examination. 
Validation Description
Medical exam history is not tracked for the specified Location Context.  Medical exam history is not tracked for the specified Location Context. 
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  [0..1]  Expiration date of person's most recent Medical Examination. 
Validation Description
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 
 
Medical_Exam_Notes  string  [0..1]  Notes for the person's most recent Medical Examination.   
Disability_Information_Data  Generic_Disability_Information_Data  [0..*]  Wrapper element for all Disability Status data for the person.   
Military_Information_Data  Generic_Military_Information_Data  [0..*]  Wrapper element for all Military Service data for the person.   
Uses_Tobacco  boolean  [0..1]  True if the person uses tobacco. To update a person's Tobacco Use, use the Put Worker Wellness Data web service.   
top
 

GenderObject

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

GenderObjectID

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

Marital_StatusObject

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

Marital_StatusObjectID

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

EthnicityObject

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

EthnicityObjectID

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

ReligionObject

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

ReligionObjectID

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

Citizenship_StatusObject

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

Citizenship_StatusObjectID

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

Country_SubregionObject

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

Country_SubregionObjectID

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

Hukou_TypeObject

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

Hukou_TypeObjectID

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

Political_AffiliationObject

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

Political_AffiliationObjectID

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

Social_Benefits_LocalityObject

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

Social_Benefits_LocalityObjectID

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

Generic_Disability_Information_Data

part of: Generic_Personal_Information_Data
Wrapper element for all Disability Status data for the person.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  When this flag is set to false, existing disability data will be preserved. When true, it causes the web service to replace all disability data with the information in the request (this is the default behavior when the entire tag is omitted).   
Disability_Status_Information_Data  Generic_Disability_Status_Information_Data  [0..*]  Wrapper element for each disability status entry. 
Validation Description
Disability Status Data is required unless the disability status is being deleted.  Disability Status Data is required unless the disability status is being deleted. 
Disability Status Reference is required when deleting a Disability Status entry.  Disability Status Reference is required when deleting a Disability Status entry. 
 
top
 

Generic_Disability_Status_Information_Data

part of: Generic_Disability_Information_Data
Wrapper element for each disability status entry.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag to delete an existing Disability status entry. If this flag is set, Disability Status Reference is also required.   
Disability_Status_Reference  Disability_Status_ReferenceObject  [0..1]  Reference to an existing Military Service entry for edits and deletes. 
Validation Description
The Disability Status Reference provided is not owned by the person in this request or does not exist.  The Disability Status Reference provided is not owned by the person in this request or does not exist. 
 
Disability_Status_Data  Generic_Disability_Status_Sub_Data  [0..1]  Container for disability status data.   
Validation Description
Disability Status Data is required unless the disability status is being deleted.  Disability Status Data is required unless the disability status is being deleted. 
Disability Status Reference is required when deleting a Disability Status entry.  Disability Status Reference is required when deleting a Disability Status entry. 
top
 

Disability_Status_ReferenceObject

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

Disability_Status_ReferenceObjectID

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

Generic_Disability_Status_Sub_Data

part of: Generic_Disability_Status_Information_Data
Container for disability status data.
 
Parameter name Type/Value Cardinality Description Validations
Disability_Reference  DisabilityObject  [1..1]  The person's Disability. 
Validation Description
The provided Disability is not valid for the person's location context. The location context is derived from the country of the location specified for the position.  The provided Disability is not valid for the person's location context. The location context is derived from the country of the location specified for the position. 
 
Disability_Status_Date  date  [0..1]  The person's Disability Status Date. 
Validation Description
The Disability Status Date cannot be before the Date of Birth  The Disability Status Date cannot be before the Date of Birth 
 
Disability_Date_Known  date  [0..1]  The date the Employer first learned about the Disability. 
Validation Description
The Disability Date Known cannot be before the Date of Birth.  The Disability Date Known cannot be before the Date of Birth. 
 
Disability_End_Date  date  [0..1]  The date through which the ~person~ is considered disabled. In some countries, this is the date through which the certification for the current level of disability is effective. 
Validation Description
The Disability End Date cannot be before the Date of Birth.  The Disability End Date cannot be before the Date of Birth. 
 
Disability_Grade_Reference  Disability_GradeObject  [0..1]  A code or number that identifies the level of Disability. 
Validation Description
The person's location context is not enabled for Disability Grade.  The person's location context is not enabled for Disability Grade. 
The provided Disability Grade is not valid for the person's location context or is inactive.  The provided Disability Grade is not valid for the person's location context or is inactive. 
 
Disability_Degree  decimal (8, 2) >0   [0..1]  A percentage that identifies the ~person's~ level of disability as of the disability date. 
Validation Description
Disability Degree can not be over 100%.   
The person's location context is not enabled for Disability Degree.  The person's location context is not enabled for Disability Degree. 
 
Disability_Remaining_Capacity  decimal (8, 2) >0   [0..1]  The percentage of labor that the person may work per Physician or other Authority. 
Validation Description
Disability Remaining Capacity can not be over 100%.  Disability Remaining Capacity can not be over 100%. 
The person's location context is not enabled for Disability Remaining Capacity.  The person's location context is not enabled for Disability Remaining Capacity. 
 
Disability_Certification_Authority_Reference [Choice]   Disability_Certification_AuthorityObject  [0..1]  The name of the person or agency that certified the Disability. 
Validation Description
The provided Disability Authority is not valid for the person's location context or is inactive.  The provided Disability Authority is not valid for the person's location context or is inactive. 
The provided Disability Authority Reference is not valid or inactive for the person's location context. Or the person's location context is not enabled for Disability Authority.  The provided Disability Authority Reference is not valid or inactive for the person's location context. Or the person's location context is not enabled for Disability Authority. 
 
Disability_Authority [Choice]   string  [0..1]  The name of the person or agency that certified the Disability. 
Validation Description
The person's location context is configured to use Disability Authority Reference.  The person's location context is configured to use Disability Authority Reference. 
The person's location context is not enabled for Disability Authority.  The person's location context is not enabled for Disability Authority. 
 
Disability_Certified_At  string  [0..1]  The place where the person or agency certified the Disability. 
Validation Description
The persons's location is not enabled for Disability Certification Location.  The persons's location is not enabled for Disability Certification Location. 
 
Disability_Certification_ID  string  [0..1]  The ID provided to the ~person~, if any. 
Validation Description
The person's location context is not enabled for Disability Certification ID.  The person's location context is not enabled for Disability Certification ID. 
 
Disability_Certification_Basis_Reference  Disability_Certification_BasisObject  [0..1]  How the ~person~ qualified for the certification. 
Validation Description
The provided Disability Certification Basis is not valid for the person's location context or is inactive.  The provided Disability Certification Basis is not valid for the person's location context or is inactive. 
The person's location context is not enabled for Disability Certification Basis.  The person's location context is not enabled for Disability Certification Basis. 
 
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.  The Disability Severity Recognition Date cannot be before the Date of Birth. 
The person's location context is not enabled for Disability Severity Recognition Date.   
 
Disability_FTE_Toward_Quota  decimal (13, 1) >0   [0..1]  The FTE that counts towards the Employer's quota for hiring the Disabled. 
Validation Description
The person's location context is not enabled for Disability FTE Toward Quota.  The person's location context is not enabled for Disability FTE Toward Quota. 
 
Disability_Work_Restrictions  string  [0..1]  List any work restrictions that apply to the ~person~.   
Disability_Accommodations_Requested  string  [0..1]  Describe any recommendation requested by the ~person~ or their care provider.   
Disability_Accommodations_Provided  string  [0..1]  Describe any accommodations provided by the Employer.   
Disability_Rehabilitation_Requested  string  [0..1]  Describe any rehabilitation measures requested by the ~person~ or their care provider.   
Disability_Rehabilitation_Provided  string  [0..1]  Describe any rehabilitation measures provided by the Employer.   
Note  string  [0..1]  Enter any additional information related to this Disability.   
Worker_Document_Reference  Worker_DocumentObject  [0..*]  Attach a copy of the certification or other documents related to this instance of Disability.   
top
 

DisabilityObject

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

DisabilityObjectID

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

Disability_GradeObject

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

Disability_GradeObjectID

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

Disability_Certification_AuthorityObject

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

Disability_Certification_AuthorityObjectID

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

Disability_Certification_BasisObject

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

Disability_Certification_BasisObjectID

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

Worker_DocumentObject

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

Worker_DocumentObjectID

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

Generic_Military_Information_Data

part of: Generic_Personal_Information_Data
Wrapper element for all Military Service data for the person.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  When this flag is set to false, existing military data will be preserved. When true, it causes the web service to replace all military data with the information in the request (this is the default behavior when the entire tag is omitted).   
Military_Service_Information_Data  Generic_Military_Service_Information_Data  [0..*]  Wrapper element for each Military Service entry. 
Validation Description
Military Service Reference is required when deleting a Military Service entry  Military Service Reference is required when deleting a Military Service entry 
 
top
 

Generic_Military_Service_Information_Data

part of: Generic_Military_Information_Data
Wrapper element for each Military Service entry.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag to delete an existing Military Service entry. If this flag is set, Military Service Reference is also required.   
Military_Service_Reference  Military_Service_ReferenceObject  [0..1]  Reference to an existing Military Service entry for edits and deletes. 
Validation Description
The Military Service Reference provided is not owned by the person in this request or does not exist.  The Military Service Reference provided is not owned by the person in this request or does not exist. 
 
Military_Service_Data  Generic_Military_Service_Sub_Data  [0..1]  Container for military service data for the Person 
Validation Description
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. 
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. 
 
Validation Description
Military Service Reference is required when deleting a Military Service entry  Military Service Reference is required when deleting a Military Service entry 
top
 

Military_Service_ReferenceObject

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

Military_Service_ReferenceObjectID

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

Generic_Military_Service_Sub_Data

part of: Generic_Military_Service_Information_Data
Container for military service data for the Person
 
Parameter name Type/Value Cardinality Description Validations
Military_Status_Reference  Military_StatusObject  [1..1]  Reference for 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. 
 
Military_Discharge_Date  date  [0..1]  Date the person was discharged from the Military. 
Validation Description
Military Discharge Date must be greater than Date of Birth.  Military Discharge Date must be greater than Date of Birth. 
 
Military_Status_Begin_Date  date  [0..1]  Begin Date for Military Service status. 
Validation Description
Military Status Begin Date must be after Date of Birth.  Military Status Begin Date must be after Date of Birth. 
 
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.   
Validation Description
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. 
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. 
top
 

Military_StatusObject

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

Military_StatusObjectID

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

Military_Service_TypeObject

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

Military_Service_TypeObjectID

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

Military_RankObject

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

Military_RankObjectID

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

Person_Identification_Data

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

National_ID

part of: Person_Identification_Data
Wrapper element for all National Identifier Data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Delete is set to True and Replace All has been set to False, the ID will be deleted when the web service is submitted. Note: The Replace All flag defaults to False if not specified in the web service   
National_ID_Reference  Unique_IdentifierObject  [0..1]  The Reference ID for the National Identifier.   
National_ID_Data  National_ID_Data  [0..1]  Wrapper element for the National Identifier Data 
Validation Description
The Identifier ID does not match the format required for the National ID Type. The Identifier ID should not contain any formatting characters.  If the Identifier ID is for a National ID Type, then formatting characters must not be included. 
National Id Type is not valid for the Country specified.  National Id Type is not valid for the Country specified. 
The ID Type ([IDType]) requires Series to also be specified.  The National ID Type specified by the ID Type requires Series. 
 
National_ID_Shared_Reference  National_Identifier_ReferenceObject  [0..1]  Shared Reference ID for National Identifiers.   
Validation Description
If the ID is marked for deletion, a National Identifier Shared Reference ID or National Identifier WID should be included.   
The National Identifier Shared Reference should be used with the Change Government IDs web service.   
The National Identifier Shared Reference should be used with the Change Government IDs web service.   
National Identifier with reference [nir] is marked for deletion. National ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The National ID referenced by [national identifier reference] does not belong to [person].   
National Identifier [identifier] with workday id [workday id] is not a valid national identifier for the person.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

National_ID_Data

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

National_ID_TypeObject

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

National_ID_TypeObjectID

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

National_Identifier_ReferenceObject

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

National_Identifier_ReferenceObjectID

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

Government_ID

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

Government_ID_Data

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

Government_ID_Type__All_Object

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

Government_ID_Type__All_ObjectID

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

Government_Identifier_ReferenceObject

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

Government_Identifier_ReferenceObjectID

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

Visa_ID

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

Visa_ID_Data

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

Visa_ID_TypeObject

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

Visa_ID_TypeObjectID

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

Visa_Identifier_ReferenceObject

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

Visa_Identifier_ReferenceObjectID

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

Passport_ID

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

Passport_ID_Data

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

Passport_ID_Type__All_Object

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

Passport_ID_Type__All_ObjectID

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

Passport_Identifier_ReferenceObject

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

Passport_Identifier_ReferenceObjectID

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

License_ID

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

License_IdentifierObject

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

License_IdentifierObjectID

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

License_ID_Data

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

License_ID_Type__All_Object

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

License_ID_Type__All_ObjectID

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

AuthorityObject

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

AuthorityObjectID

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

License_Identifier_ReferenceObject

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

License_Identifier_ReferenceObjectID

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

Custom_ID

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

Custom_ID_Data

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

Custom_ID_TypeObject

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

Custom_ID_TypeObjectID

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

OrganizationObject

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

OrganizationObjectID

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

Custom_Identifier_ReferenceObject

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

Custom_Identifier_ReferenceObjectID

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

Person_Photo_Data

part of: Create_Academic_Affiliate_Data
Person's Photo Information
 
Parameter name Type/Value Cardinality Description Validations
Filename  string (255)   [0..1]  Name of file uploaded   
File  base64Binary  [1..1]  Data of file uploaded   
top
 

Location_ContextObject

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

Location_ContextObjectID

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

Academic_Appointment_Snapshot_Data

part of: Add_Academic_Appointment_Data
Element containing the specifics for the academic appointment being added or updated. An academic appointment tracks an academic worker’s time at a university or college.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Appointment_Track_Reference  Academic_Appointment_TrackObject  [0..1]  Reference ID for the academic appointment thread being updated. Required on Update Academic Appointment events. Leave blank on Add Academic Appointment events. 
Validation Description
The academic appointment isn’t valid for this appointee.   
 
Appointment_Track_ID  string  [0..1]  Unique identifier for academic appointment track. 
Validation Description
The Academic Appointment Track ID you specified is already in use.   
 
Track_Type_Reference  Academic_Track_TypeObject  [0..1]  Reference ID for the academic track type. 
Validation Description
Academic Track Type is required for Add Academic Appointment.   
Updates to Academic Track Type are not allowed for Update Academic Appointment   
Inactive Academic Track Types are not allowed.   
This Academic Track Type is not allowed by the Academic Unit.   
The Academic Track Type Category for this Track Type is set to Inactive.   
 
Appointment_Identifier_Reference  Academic_Appointment_IdentifierObject  [1..1]  Indicates the type of appointment, such as primary, joint, or dual. Workday recommends only 1 primary active academic appointment.   
Position_Reference  Position_ElementObject  [0..1]  Appointee's filled position that's associated with an academic appointment. Can't use on the Hire subprocess, because the position isn't filled yet. 
Validation Description
[position] is not currently a valid Position for worker [worker].   
 
Academic_Unit_Reference  Academic_UnitObject  [1..1]  Reference ID for the academic unit. 
Validation Description
Select an Academic Unit that is available as of [Start Date].   
Select an Academic Unit that is available as of [Start Date].   
 
Roster_Percent  decimal (7, 4) >0   [0..1]  Percent of the academic appointee's total time on an academic appointment. Between 0.00 and 1.00. May be blank or zero for things like centers and institutes. 
Validation Description
Roster Percent cannot be greater than 100 percent (1.0).   
 
Appointment_Start_Date  date  [1..1]  Date when the appointment becomes effective or takes effect. 
Validation Description
[Academic Appointment Start Date Validation]   
 
Appointment_End_Date  date  [0..1]  Date when the academic appointment is intended to end. To end academic appointments, you must complete an End Academic Appointment Track event. 
Validation Description
Appointment End Date must be greater than the Appointment Start Date.   
 
Track_Start_Date_Override  date  [0..1]  Override for academic appointment track start date. 
Validation Description
The value supplied for the Track Start Date must be less than or equal to the Appointment Start Date.   
 
Rank_Reference  Academic_RankObject  [0..1]  Reference ID for the academic rank. 
Validation Description
The Academic Rank must be an allowed value for the Academic Track Type.   
 
Named_Professorship_Reference  Named_ProfessorshipObject  [0..1]  Reference ID for the named professorship. 
Validation Description
[professorship] is not a valid Named Professorship for the Appointment as it is in a Pending status.   
[professorship] is not a valid Named Professorship for the Appointment as it has been associated with the current Appointment track in the past.   
[professorship] is not a valid Named Professorship for the Appointment as it associated with In-Progress Edit Named Professorship event.   
[professorship] is not a valid Named Professorship for the Appointment as it associated with an In-Progress Academic Appointment event.   
[professorship] is not a valid Named Professorship for the Appointment as it is in a Discontinued status.   
[professorship] is not a valid Named Professorship for the Appointment as it is in a On Hold status.   
[professorship] is not a valid Named Professorship for the Appointment as it is Filled.   
[professorship] is not a valid Named Professorship for the Appointment as the Initial Established Date is greater than Appointment Start Date.   
 
Appointment_Specialty_Reference  Appointment_SpecialtyObject  [0..1]  Reference ID for the appointment specialty. 
Validation Description
Enter an active Appointment Specialty.   
Enter an Appointment Specialty that is associated with 1 of these: the appointment's Academic Unit, Academic Unit Hierarchy or its superiors.   
 
Constructed_Title  string  [0..1]  Do not enter, Constructed Title will be defaulted and used if all fields pertaining to rule set for track is supplied. 
Validation Description
Do not enter, Constructed Title will be defaulted and used if all fields pertaining to rule set for track is supplied.   
 
Appointment_Title  string  [1..1]  Title for the academic appointment.   
Adjusted_Title_Start_Date  date  [0..1]  Date when the academic appointment title was designated.   
Academic_Review_Date  date  [0..1]  Manually maintained date that acts as a reminder to review the academic for promotion. Only applies when the Appointment’s Track includes a Promotion program. On an update, the existing value will be retained if not sent. 
Validation Description
Academic Review Date must be greater than the Appointment Start Date.   
 
Related_Academic_Unit_Reference  Academic_UnitObject  [0..1]  Reference ID for the related academic unit. 
Validation Description
Select a Related Academic Unit that is available as of [Start Date].   
Select a Related Academic Unit that is available as of [Start Date].   
 
Tenure_Home_Reference  Academic_UnitObject  [0..1]  Reference ID for the academic unit for the tenure track appointment. 
Validation Description
Tenure Home is required If the track type includes a tenure program. Otherwise, Tenure Home is not allowed.   
Select a Tenure Home that is available as of [Start Date].   
Select a Tenure Home that is available as of [Start Date].   
 
Tenure_Status_Reference  Academic_Tenure_StatusObject  [0..1]  Reference ID for the tenure status. 
Validation Description
Tenure Status is not allowed if the Academic Track does not include a tenure program.   
Tenure Status Reference is required if the Academic Track includes tenure program.   
 
Probationary_End_Date  date  [0..1]  Date when the tenure probationary period ends. 
Validation Description
Probationary End Date is not allowed if the Academic Track Type does not include a tenure program.   
Probationary End Date must be greater than the Appointment Start Date.   
Probationary end date is not allowed if the academic tenured status has a value of true for "tenured."   
 
Tenure_Award_Date  date  [0..1]  Date when the academic appointee was awarded tenure. 
Validation Description
Tenure Award Date is not allowed if the Academic Track does not include a tenure program.   
Tenure Award Date is required if Academic Tenure Status is set to Tenured.   
Tenure Award Date is not allowed if the Academic Tenure Status is not Tenured.   
 
Validation Description
Update Date must be prior to the Academic Appointment End Date   
The key Reference ID for the Academic Appointment Track/Thread is required for an Update Academic Appointment request.   
Appointment Tracks with an In-Progress event cannot be updated or ended until the In-Progress event is completed or cancelled   
top
 

Academic_Appointment_TrackObject

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

Academic_Appointment_TrackObjectID

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

Academic_Track_TypeObject

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

Academic_Track_TypeObjectID

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

Academic_Appointment_IdentifierObject

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

Academic_Appointment_IdentifierObjectID

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

Position_ElementObject

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

Position_ElementObjectID

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

Academic_UnitObject

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

Academic_UnitObjectID

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

Academic_RankObject

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

Academic_RankObjectID

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

Named_ProfessorshipObject

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

Named_ProfessorshipObjectID

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

Appointment_SpecialtyObject

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

Appointment_SpecialtyObjectID

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

Academic_Tenure_StatusObject

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

Academic_Tenure_StatusObjectID

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

Create_Workday_Account_Sub_Business_Process

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

Business_Sub_Process_Parameters

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

System_User_Data

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

LocaleObject

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

LocaleObjectID

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

User_LanguageObject

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

User_LanguageObjectID

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

Integration_System__Audited_Object

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

Integration_System__Audited_ObjectID

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

Notification_Sub_Category_Configurations_for_Users

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

Notification_Sub_Type_Configuration

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

Notification_CategorizableObject

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

Notification_CategorizableObjectID

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

Manage_Professional_Affiliation_Sub_Business_Process_Data

part of: Add_Academic_Appointment_Data
Manage Professional Affiliation Sub Business Process Data
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..*]  Manage Professional Affiliation Sub Business Process Data   
Manage_Professional_Affiliation_Data  Manage_Professional_Affiliation_Data_for_Role  [0..*]  Manage Professional Affiliation Sub Business Process Data   
Validation Description
The "Manage Professional Affiliation Data" subelement is required if "Automatically Complete" is set to true.  The "Manage Professional Affiliation Data" subelement is required if "Automatically Complete" is set to true. 
top
 

Manage_Professional_Affiliation_Data_for_Role

part of: Manage_Professional_Affiliation_Sub_Business_Process_Data
Wrapper element for Professional Affiliation Data.
 
Parameter name Type/Value Cardinality Description Validations
Role_Reference  RoleObject  [0..1]  Role Reference 
Validation Description
Element Content 'Role_Reference' is required, on internal element 'Manage Professional Affiliation Data for Role'   
 
Source_Reference  Person_Skill_Source_CategoryObject  [0..1]  Reference to the source of the skill.   
Professional_Affiliation  Professional_Affiliation_Skill  [0..*]  Wrapper element for the Organization Professional Affiliation information. 
Validation Description
That Skill is already in use by another person. Select another one or leave it blank.   
 
top
 

RoleObject

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

RoleObjectID

part of: RoleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Contact_ID, Academic_Person_ID, Applicant_ID, Beneficiary_ID, Business_Entity_Contact_ID, Candidate_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Dependent_ID, Emergency_Contact_ID, Employee_ID, Extended_Enterprise_Contact_Person_ID, Extended_Enterprise_Learner_ID, External_Committee_Member_ID, Former_Worker_ID, Instructor_ID, Learning_Assessor_ID, Learning_Instructor_ID, LearningUserName, Organization_Reference_ID, Recruiting_Agency_User_ID, RecruitingUserName, Region_Reference_ID, Service_Center_Representative_ID, Student_ID, Student_Proxy_ID, Student_Recruiter_ID, StudentUserName, SupplierUserName, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Person_Skill_Source_CategoryObject

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

Person_Skill_Source_CategoryObjectID

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

Professional_Affiliation_Skill

part of: Manage_Professional_Affiliation_Data_for_Role
Wrapper element for the Organization Professional Affiliation information.
 
Parameter name Type/Value Cardinality Description Validations
Organization_Professional_Affiliation_Reference  Professional_Affiliation_SkillObject  [0..1]  Reference to the membership profile.   
Organization_Professional_Affiliation_Data  Professional_Affiliation_Organization_Data  [0..*]  Wrapper element for the Organization Professional Affiliation information. 
Validation Description
There is an in progress event for this worker for the membership: [membership]. Only one in progress event is allowed.  Only one change can be in progress (the event in progress and not complete or canceled) for a membership for a particular worker. 
End Date must be greater than Start Date   
Specify either the Professional Affiliation Relationship Type Reference or the Affiliation.  XORs Relationship Type Reference and Affiliation because exactly one of the two must be specified. 
Specify either the Professional Affiliation Reference or the Professional Affiliation.  XORs Affiliation Reference and Membership Org because exactly one of the two must be specified. 
Remove the Professional Affiliation Type for this Professional Affiliation Reference.  Not XORs Membership Org text field and Professional Affiliation Type Reference. Ensures that If text is specified, an ad hoc Professional Affiliation is being specified. 
You can't load inactive professional affiliations.   
You can't select Company or School as the Professional Affiliation Type for ad hoc professional affiliations.   
Workday Delivered Professional Affiliation Type must be enabled to enter Workday Delivered Professional Affiliation.   
 
Validation Description
That Skill is already in use by another person. Select another one or leave it blank.   
top
 

Professional_Affiliation_SkillObject

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

Professional_Affiliation_SkillObjectID

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

Professional_Affiliation_Organization_Data

part of: Professional_Affiliation_Skill
Wrapper element for the Organization Professional Affiliation information.
 
Parameter name Type/Value Cardinality Description Validations
Professional_Affiliation_ID  string  [0..1]  Membership ID. If no value is provided, a new membership will be created. If a value is passed in an a corresponding membership is not found, a new membership will be created with the provided id.   
Remove_Professional_Affiliation  boolean  [0..1]  Used for inbound operations to indicate that the membership should be removed for the person. Will always return false for outbound operations. 
Validation Description
Remove Membership is true without an Membership or valid Membership ID. An Membership or valid Membership ID must be specified in order to remove the Membership.   
 
Professional_Affiliation_Reference  Professional_Affiliation_ReferenceObject  [0..1]  The Professional Affiliation that this achievement is representing a relationship with.   
Professional_Affiliation  string  [0..1]  The name of the organization the person is an affiliate of. Required unless the professional affiliation is being removed. 
Validation Description
Professional affiliation must be specified unless the professional affiliation is being removed.   
 
Professional_Affiliation_Type_Reference  Professional_Affiliation_Type__All_Object  [0..1]  The type of Professional Affiliation.   
Affiliation  string  [0..1]  Any organization that the membership is affiliated to.   
Professional_Affiliation_Relationship_Type_Reference  Professional_Affiliation_Relationship_TypeObject  [0..1]  The Relationship that this Person has to this Organization.   
Begin_Date  date  [0..1]  The date when the membership was started.   
End_Date  date  [0..1]  The date when the membership was ended.   
Contact_Information_Data  Contact_Information_Data  [0..*]  All of the person's contact data (address, phone, email, instant messenger, web address). 
Validation Description
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request.  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request. 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
One and only one Institutional email address must be marked as primary.  One and only one Institutional email address must be marked as primary. 
One and only one Institutional phone must be marked as primary.  One and only one Institutional phone must be marked as primary. 
One and only one Institutional address must be marked as primary.  One and only one Institutional address must be marked as primary. 
One and only one Institutional instant messenger address must be marked as primary.  One and only one Institutional instant messenger address must be marked as primary. 
One and only one Institutional web address must be marked as primary.  One and only one Institutional web address must be marked as primary. 
Only one address of type International Assignment is allowed for a country.  Only one address of type International Assignment is allowed for a country. 
Only one address of type work from home is allowed.  Only one address of type work from home is allowed. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
At least one Primary Email must be specified in order to add an Additional Email  At least one Primary Email must be specified in order to add an Additional Email 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
At least one Primary Phone must be specified in order to add an Additional Phone  At least one Primary Phone must be specified in order to add an Additional Phone 
Either a phone number, or an email address must be specified for an emergency contact.  Either a phone number, or an email address must be specified for an emergency contact. 
Primary address on Ship-To location must have a use of [Shipping]  Primary address on Ship-To location must have a use of that maps to Shipping. 
 
Validation Description
There is an in progress event for this worker for the membership: [membership]. Only one in progress event is allowed.  Only one change can be in progress (the event in progress and not complete or canceled) for a membership for a particular worker. 
End Date must be greater than Start Date   
Specify either the Professional Affiliation Relationship Type Reference or the Affiliation.  XORs Relationship Type Reference and Affiliation because exactly one of the two must be specified. 
Specify either the Professional Affiliation Reference or the Professional Affiliation.  XORs Affiliation Reference and Membership Org because exactly one of the two must be specified. 
Remove the Professional Affiliation Type for this Professional Affiliation Reference.  Not XORs Membership Org text field and Professional Affiliation Type Reference. Ensures that If text is specified, an ad hoc Professional Affiliation is being specified. 
You can't load inactive professional affiliations.   
You can't select Company or School as the Professional Affiliation Type for ad hoc professional affiliations.   
Workday Delivered Professional Affiliation Type must be enabled to enter Workday Delivered Professional Affiliation.   
top
 

Professional_Affiliation_ReferenceObject

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

Professional_Affiliation_ReferenceObjectID

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

Professional_Affiliation_Type__All_Object

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

Professional_Affiliation_Type__All_ObjectID

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

Professional_Affiliation_Relationship_TypeObject

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

Professional_Affiliation_Relationship_TypeObjectID

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

Manage_Education_Sub_Business_Process_Data

part of: Add_Academic_Appointment_Data
Manage Education Sub Business Process Data
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..*]  Manage Education Sub Business Process Data   
Manage_Education_Data  Manage_Education_Data_for_Role  [0..*]  Manage Education Sub Business Process Data   
Validation Description
The "Manage Education Data" subelement is required if "Automatically Complete" is set to true.  The "Manage Education Data" subelement is required if "Automatically Complete" is set to true. 
top
 

Manage_Education_Data_for_Role

part of: Manage_Education_Sub_Business_Process_Data
Wrapper element for Education Data.
 
Parameter name Type/Value Cardinality Description Validations
Role_Reference  RoleObject  [0..1]  Reference to a role 
Validation Description
Element Content 'Role_Reference' is required, on internal element 'Manage Education Data for Role'   
 
Source_Reference  Person_Skill_Source_CategoryObject  [0..1]  Reference to the source of the skill.   
Education  Education  [0..*]  Wrapper element for Education information. 
Validation Description
That Skill is already in use by another person. Select another one or leave it blank.   
 
top
 

Education

part of: Manage_Education_Data_for_Role
Wrapper element for Education information.
 
Parameter name Type/Value Cardinality Description Validations
Education_Reference  Education_SkillObject  [0..1]  The reference to the education profile.   
Education_Data  Education_Achievement_Data  [0..*]  Wrapper element for Education information. 
Validation Description
The request must contain either a School Reference ID or School Name.   
There is an in progress event for this worker for the education: [education]. Only one in progress event is allowed.  Only one change can be in progress (the event in progress and not complete or canceled) for an education for a particular worker. 
If you submit Date Degree Received, the Degree Completed Reference must have a value of Yes.   
In one or more cases, the degree selected for a worker is not available in the country where the degree was earned. Please make sure to only select degrees that are available in the country that the school is in.   
If you submit School Name, Country field must have a value.   
Enter the First Year Attended.   
Enter a Last Year Attended that is after the First Year Attended.   
Enter the Last Year Attended.   
 
Validation Description
That Skill is already in use by another person. Select another one or leave it blank.   
top
 

Education_SkillObject

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

Education_SkillObjectID

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

Education_Achievement_Data

part of: Education
Wrapper element for Education information.
 
Parameter name Type/Value Cardinality Description Validations
Education_ID  string  [0..1]  Education ID. If no value is provided, a new education will be created. If a value is passed in and a corresponding education is not found a new education will be created with the provided id.   
Remove_Education  boolean  [0..1]  Used for inbound operations to indicate that the education should be removed for the person. Will always return false for outbound operations. 
Validation Description
Remove Education is true without an Education or valid Education ID. An Education or valid Education ID must be specified in order to remove the Education.   
 
Country_Reference  CountryObject  [1..1]  The Reference of the Country in which the school is located. If the Country Reference and School Name matches an entry from the Schools report, this reference will not be set; a School Reference will be used instead.   
School_Reference  SchoolObject  [0..1]  The Reference of the School where the education was received. The Schools report returns all of the schools that can be referenced.   
School_Name  string  [0..1]  The name of the education institution.   
School_Type_Reference  School_TypeObject  [0..1]  A Reference of the of School Type. If a School Reference is submitted, or found by a matching Country Reference and School Name, this value will not be saved because the School Reference is linked to a School Type.   
Location  string  [0..1]  The text location of the education institution. If a School Reference is submitted, or found by a matching Country Reference and School Name, this value will not be saved.   
Degree_Reference  DegreeObject  [0..1]  The degree earned.   
Degree_Completed_Reference  Degree_CompletedObject  [0..1]  Indicates whether the degree was received.   
Date_Degree_Received  date  [0..1]  The date on which the degree was awarded.   
Field_Of_Study_Reference  Field_of_StudyObject  [0..1]  The field of study.   
Grade_Average  string  [0..1]  The grade point average.   
First_Year_Attended  date  [0..1]  The first year of attendance. This field should be in YYYY-MM-DD format, however the month and day will be ignored.   
Last_Year_Attended  date  [0..1]  The last year of attendance. Should be displayed in YYYY-MM-DD format, but the month and day will be ignored.   
Is_Highest_Level_of_Education  boolean  [0..1]  Indicates whether this is the worker's highest level of education. Degrees are ranked using Qualification Rating Value. If a worker has two or more equivalent degrees, the most recent one is considered highest.   
First_Day_Attended  date  [0..1]  The first date of attendance using day month year precision. Note this can only be populated when the Education is for a Worker in a Country that has been configured to 'Use Date with Day Precision for Education' on Tenant Setup - Global.   
Last_Day_Attended  date  [0..1]  The last date of attendance using day month year precision. Note this can only be populated when the Education is for a Worker in a Country that has been configured to 'Use Date with Day Precision for Education' on Tenant Setup - Global.   
Validation Description
The request must contain either a School Reference ID or School Name.   
There is an in progress event for this worker for the education: [education]. Only one in progress event is allowed.  Only one change can be in progress (the event in progress and not complete or canceled) for an education for a particular worker. 
If you submit Date Degree Received, the Degree Completed Reference must have a value of Yes.   
In one or more cases, the degree selected for a worker is not available in the country where the degree was earned. Please make sure to only select degrees that are available in the country that the school is in.   
If you submit School Name, Country field must have a value.   
Enter the First Year Attended.   
Enter a Last Year Attended that is after the First Year Attended.   
Enter the Last Year Attended.   
top
 

SchoolObject

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

SchoolObjectID

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

School_TypeObject

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

School_TypeObjectID

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

DegreeObject

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

DegreeObjectID

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

Degree_CompletedObject

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

Degree_CompletedObjectID

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

Field_of_StudyObject

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

Field_of_StudyObjectID

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

Manage_Instructor_Eligibility_Sub_Business_Process_Data

part of: Add_Academic_Appointment_Data
Manage Instructor Eligibility Sub Business Process Data
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..*]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Instructor_Eligibility_Line_Data  Instructor_Eligibility_Line_Data  [0..*]  Contains Instructor Eligibility Line Data 
Validation Description
Eligibility line must contain at least one criteria.   
 
top
 

Instructor_Eligibility_Line_Data

part of: Manage_Instructor_Eligibility_Sub_Business_Process_Data
Contains Instructor Eligibility Line Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_UnitObject  [0..1]  Academic unit where the instructor is eligible to teach. 
Validation Description
The Academic Unit must be configured for the Academic Level on the Snapshot Date, with "Offer Courses" configuration option.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic levels that the instructor is eligible to teach. 
Validation Description
Academic Level(s) must be valid for Academic Unit and Snapshot Effective Date.   
 
Course_Subject_Reference  Course_SubjectObject  [0..*]  Course subjects that the instructor is eligible to teach. 
Validation Description
Course subject(s) must be valid. A course subject is valid if: The academic unit of the course subject is in common with the academic unit for this eligibility line.   
 
Course_Reference  Course_DefinitionObject  [0..*]  Courses that the instructor is eligible to teach. 
Validation Description
Course must be valid. A course is valid if: 1) The academic level for the course is in common with the academic levels for this eligibility line. 2) The academic unit(s) for the course is in common with the academic unit for this eligibility line. 3) The course subject for the course is in common with the course subjects for this eligibility line.   
 
Delivery_Mode_Reference  Delivery_ModeObject  [0..*]  Delivery modes for which the instructor is eligible. 
Validation Description
Select a Student Specific Delivery Mode.   
 
Course_Tag_Reference  Student_Course_TagObject  [0..*]  Course tags for the courses that the instructor is eligible to teach.   
Location_Reference  LocationObject  [0..*]  Locations where the instructor is eligible to teach. 
Validation Description
All Locations must be Campus Locations.   
 
Educational_Taxonomy_Code_Reference  Educational_Taxonomy_CodeObject  [0..*]  Educational taxonomy codes for the courses that the instructor is eligible to teach. 
Validation Description
Select an active Educational Taxonomy Code that is part of an active taxonomy scheme.   
 
Validation Description
Eligibility line must contain at least one criteria.   
top
 

Academic_LevelObject

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

Academic_LevelObjectID

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

Course_SubjectObject

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

Course_SubjectObjectID

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

Course_DefinitionObject

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

Course_DefinitionObjectID

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

Delivery_ModeObject

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

Delivery_ModeObjectID

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

Student_Course_TagObject

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

Student_Course_TagObjectID

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

LocationObject

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

LocationObjectID

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

Educational_Taxonomy_CodeObject

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

Educational_Taxonomy_CodeObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

General_Event_SubcategoryReferenceEnumeration

part of: General_Event_SubcategoryObjectID
Base Type
string
top
 

Academic_Appointee_EnabledReferenceEnumeration

part of: Academic_Appointee_EnabledObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_Predefined_Person_Name_Component_ValueReferenceEnumeration

part of: Country_Predefined_Person_Name_Component_ValueObjectID
Base Type
string
top
 

Additional_Name_TypeReferenceEnumeration

part of: Additional_Name_TypeObjectID
Base Type
string
top
 

Country_CityReferenceEnumeration

part of: Country_CityObjectID
Base Type
string
top
 

Base Type
string

top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Communication_Usage_TypeReferenceEnumeration

part of: Communication_Usage_TypeObjectID
Base Type
string
top
 

Communication_Usage_BehaviorReferenceEnumeration

part of: Communication_Usage_BehaviorObjectID
Base Type
string
top
 

Communication_Usage_Behavior_TenantedReferenceEnumeration

part of: Communication_Usage_Behavior_TenantedObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top
 

Phone_Device_TypeReferenceEnumeration

part of: Phone_Device_TypeObjectID
Base Type
string
top
 

Phone_ReferenceReferenceEnumeration

part of: Phone_ReferenceObjectID
Base Type
string
top
 

Email_ReferenceReferenceEnumeration

part of: Email_ReferenceObjectID
Base Type
string
top
 

Instant_Messenger_TypeReferenceEnumeration

part of: Instant_Messenger_TypeObjectID
Base Type
string
top
 

Instant_Messenger_ReferenceReferenceEnumeration

part of: Instant_Messenger_ReferenceObjectID
Base Type
string
top
 

Web_Address_ReferenceReferenceEnumeration

part of: Web_Address_ReferenceObjectID
Base Type
string
top
 

GenderReferenceEnumeration

part of: GenderObjectID
Base Type
string
top
 

Marital_StatusReferenceEnumeration

part of: Marital_StatusObjectID
Base Type
string
top
 

Base Type
string

top
 

EthnicityReferenceEnumeration

part of: EthnicityObjectID
Base Type
string
top
 

ReligionReferenceEnumeration

part of: ReligionObjectID
Base Type
string
top
 

Citizenship_StatusReferenceEnumeration

part of: Citizenship_StatusObjectID
Base Type
string
top
 

Country_SubregionReferenceEnumeration

part of: Country_SubregionObjectID
Base Type
string
top
 

Hukou_TypeReferenceEnumeration

part of: Hukou_TypeObjectID
Base Type
string
top
 

Political_AffiliationReferenceEnumeration

part of: Political_AffiliationObjectID
Base Type
string
top
 

Social_Benefits_LocalityReferenceEnumeration

part of: Social_Benefits_LocalityObjectID
Base Type
string
top
 

Disability_Status_ReferenceReferenceEnumeration

part of: Disability_Status_ReferenceObjectID
Base Type
string
top
 

DisabilityReferenceEnumeration

part of: DisabilityObjectID
Base Type
string
top
 

Disability_GradeReferenceEnumeration

part of: Disability_GradeObjectID
Base Type
string
top
 

Disability_Certification_AuthorityReferenceEnumeration

part of: Disability_Certification_AuthorityObjectID
Base Type
string
top
 

Disability_Certification_BasisReferenceEnumeration

part of: Disability_Certification_BasisObjectID
Base Type
string
top
 

Worker_DocumentReferenceEnumeration

part of: Worker_DocumentObjectID
Base Type
string
top
 

Military_Service_ReferenceReferenceEnumeration

part of: Military_Service_ReferenceObjectID
Base Type
string
top
 

Military_StatusReferenceEnumeration

part of: Military_StatusObjectID
Base Type
string
top
 

Military_Service_TypeReferenceEnumeration

part of: Military_Service_TypeObjectID
Base Type
string
top
 

Military_RankReferenceEnumeration

part of: Military_RankObjectID
Base Type
string
top
 

RichText

part of: Generic_Military_Service_Sub_Data
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

National_ID_TypeReferenceEnumeration

part of: National_ID_TypeObjectID
Base Type
string
top
 

National_Identifier_ReferenceReferenceEnumeration

part of: National_Identifier_ReferenceObjectID
Base Type
string
top
 

Government_ID_Type__All_ReferenceEnumeration

part of: Government_ID_Type__All_ObjectID
Base Type
string
top
 

Government_Identifier_ReferenceReferenceEnumeration

part of: Government_Identifier_ReferenceObjectID
Base Type
string
top
 

Visa_ID_TypeReferenceEnumeration

part of: Visa_ID_TypeObjectID
Base Type
string
top
 

Visa_Identifier_ReferenceReferenceEnumeration

part of: Visa_Identifier_ReferenceObjectID
Base Type
string
top
 

Passport_ID_Type__All_ReferenceEnumeration

part of: Passport_ID_Type__All_ObjectID
Base Type
string
top
 

Passport_Identifier_ReferenceReferenceEnumeration

part of: Passport_Identifier_ReferenceObjectID
Base Type
string
top
 

License_IdentifierReferenceEnumeration

part of: License_IdentifierObjectID
Base Type
string
top
 

License_ID_Type__All_ReferenceEnumeration

part of: License_ID_Type__All_ObjectID
Base Type
string
top
 

AuthorityReferenceEnumeration

part of: AuthorityObjectID
Base Type
string
top
 

License_Identifier_ReferenceReferenceEnumeration

part of: License_Identifier_ReferenceObjectID
Base Type
string
top
 

Custom_ID_TypeReferenceEnumeration

part of: Custom_ID_TypeObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Custom_Identifier_ReferenceReferenceEnumeration

part of: Custom_Identifier_ReferenceObjectID
Base Type
string
top
 

Location_ContextReferenceEnumeration

part of: Location_ContextObjectID
Base Type
string
top
 

Base Type
string

top
 

Academic_Appointment_TrackReferenceEnumeration

part of: Academic_Appointment_TrackObjectID
Base Type
string
top
 

Academic_Track_TypeReferenceEnumeration

part of: Academic_Track_TypeObjectID
Base Type
string
top
 

Academic_Appointment_IdentifierReferenceEnumeration

part of: Academic_Appointment_IdentifierObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_RankReferenceEnumeration

part of: Academic_RankObjectID
Base Type
string
top
 

Named_ProfessorshipReferenceEnumeration

part of: Named_ProfessorshipObjectID
Base Type
string
top
 

Appointment_SpecialtyReferenceEnumeration

part of: Appointment_SpecialtyObjectID
Base Type
string
top
 

Academic_Tenure_StatusReferenceEnumeration

part of: Academic_Tenure_StatusObjectID
Base Type
string
top
 

LocaleReferenceEnumeration

part of: LocaleObjectID
Base Type
string
top
 

User_LanguageReferenceEnumeration

part of: User_LanguageObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

Notification_CategorizableReferenceEnumeration

part of: Notification_CategorizableObjectID
Base Type
string
top
 

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top
 

Person_Skill_Source_CategoryReferenceEnumeration

part of: Person_Skill_Source_CategoryObjectID
Base Type
string
top
 

Professional_Affiliation_SkillReferenceEnumeration

part of: Professional_Affiliation_SkillObjectID
Base Type
string
top
 

Professional_Affiliation_ReferenceReferenceEnumeration

part of: Professional_Affiliation_ReferenceObjectID
Base Type
string
top
 

Professional_Affiliation_Type__All_ReferenceEnumeration

part of: Professional_Affiliation_Type__All_ObjectID
Base Type
string
top
 

Professional_Affiliation_Relationship_TypeReferenceEnumeration

part of: Professional_Affiliation_Relationship_TypeObjectID
Base Type
string
top
 

Education_SkillReferenceEnumeration

part of: Education_SkillObjectID
Base Type
string
top
 

SchoolReferenceEnumeration

part of: SchoolObjectID
Base Type
string
top
 

School_TypeReferenceEnumeration

part of: School_TypeObjectID
Base Type
string
top
 

DegreeReferenceEnumeration

part of: DegreeObjectID
Base Type
string
top
 

Degree_CompletedReferenceEnumeration

part of: Degree_CompletedObjectID
Base Type
string
top
 

Field_of_StudyReferenceEnumeration

part of: Field_of_StudyObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Course_SubjectReferenceEnumeration

part of: Course_SubjectObjectID
Base Type
string
top
 

Course_DefinitionReferenceEnumeration

part of: Course_DefinitionObjectID
Base Type
string
top
 

Delivery_ModeReferenceEnumeration

part of: Delivery_ModeObjectID
Base Type
string
top
 

Student_Course_TagReferenceEnumeration

part of: Student_Course_TagObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Educational_Taxonomy_CodeReferenceEnumeration

part of: Educational_Taxonomy_CodeObjectID
Base Type
string
top