Service Directory > v25.1 > Student_Recruiting > Submit_Student_Recruiter
 

Operation: Submit_Student_Recruiter

Creates or updates a Student Recruiter. If an reference to an existing Worker is specified, only recruiter information is needed. If no Worker reference is specified, a new Recruiting Person will be created, and Name and Contact information will be required at creation.


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

Put Request to create/update a Student Recruiter
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Student_Recruiter_Reference  Admissions_CounselorObject  [0..1]  References an existing instance to update or creates a new Student Recruiter   
Student_Recruiter_Data  Student_Recruiter_Data  [1..1]  Contains Student Recruiter Data 
Validation Description
Enter the Student Recruiter’s Contact Information.  This validation checks that either a reference to an existing Worker, the Student Recruiter Person Data element, or a reference to a Student Recruiter that was made using an existing Worker is provided. The information on the Worker will always take precedence over the information in the Student Recruiter Person Data element. 
The Worker cannot be changed for this Student Recruiter.  This validation checks that the referenced Student Recruiter was made using the referenced Worker if both a reference to an existing Worker and a reference to an existing Student Recruiter are provided in the incoming request. If either a reference to a Student Recruiter or Worker is not provided in the request, this validation will not be triggered. 
The Worker is already a Student Recruiter; a reference to the existing Student Recruiter must be provided.  This validation checks that the referenced Worker belongs with the referenced Student Recruiter if both a reference to an existing Student Recruiter and a reference to an existing Worker are provided in the incoming request. If there is no Worker reference provided, or the Worker provided has not been made into a Recruiter, then this validation will not be triggered. 
Start and end dates are for guest recruiters only.  This validation checks to make sure a start or end date is not entered if a student recruiter is a staff type. 
 
Validation Description
The Web Service is set to Add Only, but the Student Recruiter already exists.   
top
 

Response Element: Submit_Student_Recruiter_Response

Put Response for Student Recruiters
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Recruiter_Reference  Admissions_CounselorObject  [0..1]  References a Student Recruiter   
top
 

Admissions_CounselorObject

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

Admissions_CounselorObjectID

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

part of: Submit_Student_Recruiter_Request
Contains Person Data, Region, and Recruiting Discipline information for a Student Recruiter
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for a Student Recruiter   
Worker_Reference  WorkerObject  [0..1]  Reference of an existing Worker to make a Student Recruiter.   
Student_Recruiter_Person_Data  Student_Recruiter_Person_Data  [0..1]  Contains Person Data for a Student Recruiter 
Validation Description
Please enter at least one address, phone number, or email address.   
Academic Contact is not an allowed Communication Usage Type for Phone.   
Academic Contact is not an allowed Communication Usage Type for Address.   
Academic Contact is not an allowed Communication Usage Type for Email Address.   
Academic Contact is not an allowed Communication Usage Type for Web Address.   
Academic Contact is not an allowed Communication Usage Type for Instant Messenger.   
 
Student_Recruiter_Type_Reference  Admissions_Counselor_TypeObject  [1..1]  References a Student Recruiter Type   
Start_Date  date  [0..1]  The Start Date for a Student Recruiter with Type of Guest 
Validation Description
The Student Recruiter End Date must be greater than the Student Recruiter Start Date.  The Student Recruiter End Date must be greater than the Student Recruiter Start Date. 
The Student Recruiter is of type Guest. Start and End Dates must be provided.  The Student Recruiter is of type Guest. Start and End Dates must be provided. 
 
End_Date  date  [0..1]  The End Date for a Student Recruiter with Type of Guest.   
Inactive  boolean  [0..1]  Indicates if a Student Recruiter is active/inactive   
Prospect_Assignment_Criteria_Data  Prospect_Assignment_Criteria_Data  [0..*]  Contains Prospect Assignment Criteria for a Student Recruiter. 
Validation Description
Prospect assignment criteria rows must be unique.   
 
Validation Description
Enter the Student Recruiter’s Contact Information.  This validation checks that either a reference to an existing Worker, the Student Recruiter Person Data element, or a reference to a Student Recruiter that was made using an existing Worker is provided. The information on the Worker will always take precedence over the information in the Student Recruiter Person Data element. 
The Worker cannot be changed for this Student Recruiter.  This validation checks that the referenced Student Recruiter was made using the referenced Worker if both a reference to an existing Worker and a reference to an existing Student Recruiter are provided in the incoming request. If either a reference to a Student Recruiter or Worker is not provided in the request, this validation will not be triggered. 
The Worker is already a Student Recruiter; a reference to the existing Student Recruiter must be provided.  This validation checks that the referenced Worker belongs with the referenced Student Recruiter if both a reference to an existing Student Recruiter and a reference to an existing Worker are provided in the incoming request. If there is no Worker reference provided, or the Worker provided has not been made into a Recruiter, then this validation will not be triggered. 
Start and end dates are for guest recruiters only.  This validation checks to make sure a start or end date is not entered if a student recruiter is a staff type. 
top
 

WorkerObject

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

Student_Recruiter_Person_Data

part of: Student_Recruiter_Data
Contains Legal Name and Contact Information for a Student Recruiter
 
Parameter name Type/Value Cardinality Description Validations
Legal_Name_Data  Legal_Name_Data  [1..*]  Contains the legal name for a person. A person must name one and only one legal name.   
Contact_Information_Data  Contact_Information_Data  [1..*]  All of the person's contact data (address, phone, email, instant messenger, web address). 
Validation Description
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
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. 
 
Validation Description
Please enter at least one address, phone number, or email address.   
Academic Contact is not an allowed Communication Usage Type for Phone.   
Academic Contact is not an allowed Communication Usage Type for Address.   
Academic Contact is not an allowed Communication Usage Type for Email Address.   
Academic Contact is not an allowed Communication Usage Type for Web Address.   
Academic Contact is not an allowed Communication Usage Type for Instant Messenger.   
top
 

Legal_Name_Data

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

Person_Name_Detail_Data

part of: Legal_Name_Data
Contains the components of a name, such as the First Name and Last Name.
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Name  string  [1..1]  Contains, in one string, a fully formatted name with all of its pieces in their proper place. This name is only used in a response and is not used for requests.   
@Reporting_Name  string  [1..1]  Contains, in one string, a fully formatted name for reporting with all of its pieces in their proper place. This name is only used in a response and is not used for requests.   
Country_Reference  CountryObject  [1..1]  The country that the name is for. 
Validation Description
If one local script is submitted, all required local script name fields must be submitted.   
If one western script is submitted, all required western script name fields must be submitted.   
Local name is not enabled for this country.   
 
Prefix_Data  Person_Name_Prefix_Data  [0..1]  Contains the prefixes for a name.   
First_Name  string  [0..1]  The first name (given name) for a person. 
Validation Description
First Name is not setup for this country.   
First Name (or Local First Name if configured) is required for this country.   
 
Middle_Name  string  [0..1]  The middle name for a person. 
Validation Description
Middle Name is not setup for this country.   
Middle Name (or Local Middle Name if configured) is required for this country.   
 
Last_Name  string  [0..1]  The last name (family name) for a person. 
Validation Description
Last Name is not set up for this country.   
Last Name (or Local Last Name if configured) is required for this country.   
 
Secondary_Last_Name  string  [0..1]  The secondary last name (family name) for a person. 
Validation Description
Secondary Last Name (or Local Secondary Last Name) is required for this country.   
Last Name - Secondary is not set up for this country.   
 
Local_Name_Detail_Data  Local_Person_Name_Detail_Data  [0..1]  Contains the name components in local script for supporting countries.   
Suffix_Data  Person_Name_Suffix_Data  [0..1]  Contains the suffixes for a name.   
Full_Name_for_Singapore_and_Malaysia  string  [0..1]  Full Person Name is used by Malaysia and Singapore. It is designed for workers in these countries to enter their full legal name. It is an attribute of Global Person Name class and is not a concatenation of First and Last names. 
Validation Description
Full Name is not set up for this country.   
 
top
 

CountryObject

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

CountryObjectID

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

Person_Name_Prefix_Data

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

Country_Predefined_Person_Name_Component_ValueObject

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

Country_Predefined_Person_Name_Component_ValueObjectID

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

Local_Person_Name_Detail_Data

part of: Person_Name_Detail_Data
Contains the components of a name in local script, such as the First Name and Last Name, for supporting countries.
 
Parameter name Type/Value Cardinality Description Validations
@Local_Name  string  [1..1]  Contains the formatted local name in local script as configured for the country.   
@Local_Script  string  [1..1]  Contains the formatted local script name which contains the ISO code and name.   
First_Name  string  [0..1]  Contains first name in local script, which is generally configured to as Given Name, for supporting countries.   
Middle_Name  string  [0..1]  Contains middle name in local script for supporting countries.   
Last_Name  string  [0..1]  Contains last name in local script, which is generally configured to as Family Name, for supporting countries.   
Secondary_Last_Name  string  [0..1]  Contains secondary last name in local script, which is generally configured to as Maternal Family Name, for supporting countries.   
First_Name_2  string  [0..1]  Contains first name in second local script, which is generally configured to as Given Name, for supporting countries.   
Middle_Name_2  string  [0..1]  Contains middle name in second local script for supporting countries.   
Last_Name_2  string  [0..1]  Contains last name in second local script, which is generally configured to as Given Name, for supporting countries.   
Secondary_Last_Name_2  string  [0..1]  Contains secondary last name in second local script, which is generally configured to as Maternal Family Name, for supporting countries.   
top
 

Person_Name_Suffix_Data

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

Contact_Information_Data

part of: Student_Recruiter_Person_Data
All of the person's contact data (address, phone, email, instant messenger, web address).
 
Parameter name Type/Value Cardinality Description Validations
Address_Data  Address_Information_Data  [0..*]  Address information 
Validation Description
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Usage Type and Use For combination must be valid for Address.  Usage Type and Use For combination must be valid for Address. 
Second Address Line is required for certain countries.  Second Address Line is required for certain countries. 
Third Address Line is required for certain countries.  Third Address Line is required for certain countries. 
Fourth Address Line is required for certain countries.  Fourth Address Line is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Second Submunicipality is required for certain countries.  Second Submunicipality is required for certain countries. 
Second Address Line is not a valid address component for certain countries.  Second Address Line is not a valid address component for certain countries. 
Third Address Line is not a valid address component for certain countries.  Third Address Line is not a valid address component for certain countries. 
Fourth Address Line is not a valid address component for certain countries.  Fourth Address Line is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
A maximum of four Submunicipalities are allowed in an address.  A maximum of four Submunicipalities are allowed in an address. 
A maximum of four Subregions are allowed in an address.  A maximum of four Subregions are allowed in an address. 
A maximum of four Address Lines are allowed in an address.  A maximum of four Address Lines are allowed in an address. 
Region is required for certain countries.  Region is required for certain countries. 
Address Line is required for certain countries.  Address Line is required for certain countries. 
Home addresses which are not additionally used as work addresses cannot be marked as public.  Home addresses which are not additionally used as work addresses cannot be marked as public. 
[postal code] is not a valid postal code for [region]  Postal Code must be valid for the Region. 
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Address Line 1 - Local is not valid for this Country.  Address Line 1 - Local is not valid for this Country. 
Municipality - Local is not a valid address component for certain countries .  Municipality - Local is not a valid address component for certain countries . 
Address Line 2 - Local is not valid for this Country.  Address Line 2 - Local is not valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not a valid address component for certain countries.  City Subdivision 1 - Local is not a valid address component for certain countries. 
City Subdivision 2 - Local is not a valid address component for certain countries.  City Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 1 - Local is not a valid address component for certain countries.  Region Subdivision 1 - Local is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not a valid address component for certain countries.  Region Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 2 is not a valid address component for certain countries.  Region Subdivision 2 is not a valid address component for certain countries. 
City Subdivision 2 is not a valid address component for certain countries.  City Subdivision 2 is not a valid address component for certain countries. 
Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country.  Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country. 
Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country.  Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country. 
Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
Address Reference is required when deleting an address  Address Reference is required when deleting an address 
Usage Data is required unless address is being deleted  Usage Data is required unless address is being deleted 
Country Reference is required unless address is being deleted  Country Reference is required unless address is being deleted 
Address deletion is not supported in this web service request  Address deletion is not supported in this web service request 
If one western script field is submitted, all required western script address fields must be submitted.  If one western script field is submitted, all required western script address fields must be submitted. 
Address Reference must match an existing (and not deleted) address in use by the worker subject of this request  Address Reference must match an existing (and not deleted) address in use by the worker subject of this request 
Address "[ID]" is already in use by another address (possibly on another contactable). Please choose a different Address ID.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
Use a unique Address Reference ID for each address. [ID] is already used on another address.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
You can only update addresses that belong to this customer.   
You can't use an existing address for a new customer.   
Existing addresses can't be future dated. Select an effective date that is on or before today, or create a new address with a future date.   
The Address ID must match the Address Reference.   
You can't use an existing address for a new customer request.   
You can't use an existing address for a new prospect.   
You can only update addresses that belong to this customer request.   
You can only update addresses that belong to this prospect.   
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].   
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.   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
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].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
 
Phone_Data  Phone_Information_Data  [0..*]  Phone Information 
Validation Description
Invalid Usage Type and Use For combination for Phone.  Invalid Usage Type and Use For combination for Phone. 
[country code] is not a valid country code for [country iso code]   
[country iso code] is not a valid country code   
You cannot specify the same usage type more than once for an address.   
Element Content 'Phone Number' is required, on internal element 'Phone Information Data'  Element Content 'Phone Number' is required, on internal element 'Phone Information Data' 
Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data'  Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data' 
Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data'  Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data' 
 
Email_Address_Data  Email_Address_Information_Data  [0..*]  Email Address Information 
Validation Description
Invalid Usage Type and Use For combination for Email Address.  Invalid Usage Type and Use For combination for Email Address. 
You cannot specify the same usage type more than once for an address.   
 
Instant_Messenger_Data  Instant_Messenger_Information_Data  [0..*]  Instant Messenger Information 
Validation Description
Invalid Usage Type and Use For combination for Instant Messenger Address.  Invalid Usage Type and Use For combination for Instant Messenger Address. 
You cannot specify the same usage type more than once for an address.   
 
Web_Address_Data  Web_address_Information_Data  [0..*]  Web Address Information 
Validation Description
Invalid Usage Type and Use For combination for Web Address.  Invalid Usage Type and Use For combination for Web Address. 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
You cannot specify the same usage type more than once for an address.   
 
Validation Description
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
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. 
top
 

Address_Information_Data

part of: Contact_Information_Data
Address information
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Address  string  [1..1]  Returns the formatted address in the format specified for the country. This data is not used for inbound requests and any data provided in this element will be ignored.   
@Address_Format_Type  string  [1..1]  The format type of the address.   
@Defaulted_Business_Site_Address  boolean  [1..1]  Set to 1 if the address is a defaulted location address. If this value is 1, this address will not be processed for inbound web services.   
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced address. If this flag is set, the Reference ID field becomes required, and all other address fields that would otherwise be required will be optional and meaningless. 
Validation Description
The referenced address is in use as a primary home address and cannot be deleted.  The referenced address is in use as a primary home address and cannot be deleted. 
 
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary address data will be replaced. A value of true means only the referenced address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY address in the request.   
@Effective_Date  date  [1..1]  Effective Date of Address.   
Country_Reference  CountryObject  [0..1]  Country for the address.   
Last_Modified  dateTime  [0..1]  The moment when the address was last modified.   
Address_Line_Data  Address_Line_Information_Data  [0..*]  The address line for the address. This typically contains Street name, street number, apartment, suite number. 
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
 
Municipality  string  [0..1]  City part of the address.   
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.   
Subregion_Data  Subregion_Information_Data  [0..*]  The subregion part of the address.   
Postal_Code  string  [0..1]  The Postal Code part of the address.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Municipality_Local  string  [0..1]  City in local script part of the address.   
Address_Reference  Address_ReferenceObject  [0..1]  The Address Reference ID.   
Address_ID  string  [0..1]  New ID value used in address updates. The ID cannot already be in use by another address.   
Validation Description
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Usage Type and Use For combination must be valid for Address.  Usage Type and Use For combination must be valid for Address. 
Second Address Line is required for certain countries.  Second Address Line is required for certain countries. 
Third Address Line is required for certain countries.  Third Address Line is required for certain countries. 
Fourth Address Line is required for certain countries.  Fourth Address Line is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Second Submunicipality is required for certain countries.  Second Submunicipality is required for certain countries. 
Second Address Line is not a valid address component for certain countries.  Second Address Line is not a valid address component for certain countries. 
Third Address Line is not a valid address component for certain countries.  Third Address Line is not a valid address component for certain countries. 
Fourth Address Line is not a valid address component for certain countries.  Fourth Address Line is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
A maximum of four Submunicipalities are allowed in an address.  A maximum of four Submunicipalities are allowed in an address. 
A maximum of four Subregions are allowed in an address.  A maximum of four Subregions are allowed in an address. 
A maximum of four Address Lines are allowed in an address.  A maximum of four Address Lines are allowed in an address. 
Region is required for certain countries.  Region is required for certain countries. 
Address Line is required for certain countries.  Address Line is required for certain countries. 
Home addresses which are not additionally used as work addresses cannot be marked as public.  Home addresses which are not additionally used as work addresses cannot be marked as public. 
[postal code] is not a valid postal code for [region]  Postal Code must be valid for the Region. 
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Address Line 1 - Local is not valid for this Country.  Address Line 1 - Local is not valid for this Country. 
Municipality - Local is not a valid address component for certain countries .  Municipality - Local is not a valid address component for certain countries . 
Address Line 2 - Local is not valid for this Country.  Address Line 2 - Local is not valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not a valid address component for certain countries.  City Subdivision 1 - Local is not a valid address component for certain countries. 
City Subdivision 2 - Local is not a valid address component for certain countries.  City Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 1 - Local is not a valid address component for certain countries.  Region Subdivision 1 - Local is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not a valid address component for certain countries.  Region Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 2 is not a valid address component for certain countries.  Region Subdivision 2 is not a valid address component for certain countries. 
City Subdivision 2 is not a valid address component for certain countries.  City Subdivision 2 is not a valid address component for certain countries. 
Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country.  Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country. 
Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country.  Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country. 
Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
Address Reference is required when deleting an address  Address Reference is required when deleting an address 
Usage Data is required unless address is being deleted  Usage Data is required unless address is being deleted 
Country Reference is required unless address is being deleted  Country Reference is required unless address is being deleted 
Address deletion is not supported in this web service request  Address deletion is not supported in this web service request 
If one western script field is submitted, all required western script address fields must be submitted.  If one western script field is submitted, all required western script address fields must be submitted. 
Address Reference must match an existing (and not deleted) address in use by the worker subject of this request  Address Reference must match an existing (and not deleted) address in use by the worker subject of this request 
Address "[ID]" is already in use by another address (possibly on another contactable). Please choose a different Address ID.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
Use a unique Address Reference ID for each address. [ID] is already used on another address.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
You can only update addresses that belong to this customer.   
You can't use an existing address for a new customer.   
Existing addresses can't be future dated. Select an effective date that is on or before today, or create a new address with a future date.   
The Address ID must match the Address Reference.   
You can't use an existing address for a new customer request.   
You can't use an existing address for a new prospect.   
You can only update addresses that belong to this customer request.   
You can only update addresses that belong to this prospect.   
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].   
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.   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
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].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
top
 

Address_Line_Information_Data

part of: Address_Information_Data
The address line for the address. This typically contains Street name, street number, apartment, suite number.
 
Parameter name Type/Value Cardinality Description Validations
#text  string     
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
 
@Descriptor  string  [1..1]  The Descriptor is an optional serialized attribute that shows the text Override Label (such as Apartment Number or Building Number) that helps describe the usage of the Type (such as ADDRESS_LINE_5 and ADDRESS_LINE_6) for each Country.   
@Type  string  [1..1]  Enter the Address Line Type, such as ADDRESS_LINE_1, or ADDRESS_LINE_2.   
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
top
 

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

Country_RegionObjectID

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

Subregion_Information_Data

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

Communication_Method_Usage_Information_Data

part of: Address_Information_Data, Phone_Information_Data, Email_Address_Information_Data, Instant_Messenger_Information_Data, Web_address_Information_Data
Encapsulating element for all Communication Method Usage data.
 
Parameter name Type/Value Cardinality Description Validations
@Public  boolean  [1..1]  Indicates if the address is public.   
Type_Data  Communication_Usage_Type_Data  [1..*]  Encapsulation element for the Communication Usage Type.   
Use_For_Reference  Communication_Usage_BehaviorObject  [0..*]  Reference ID for Communication Usage Behavior. 
Validation Description
Please provide usages that are Workday Owned or Tenanted - not both.   
 
Use_For_Tenanted_Reference  Communication_Usage_Behavior_TenantedObject  [0..*]  Reference ID for Communication Usage Behavior Tenanted. 
Validation Description
Please provide usages that are Workday Owned or Tenanted - not both.   
 
Comments  string  [0..1]  Description of the address, phone, email, instant messenger or web address   
top
 

Communication_Usage_Type_Data

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

Communication_Usage_TypeObject

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

Communication_Usage_TypeObjectID

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

Communication_Usage_BehaviorObject

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

Communication_Usage_BehaviorObjectID

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

Communication_Usage_Behavior_TenantedObject

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

Communication_Usage_Behavior_TenantedObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Phone_Information_Data

part of: Contact_Information_Data
Phone Information
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Phone  string  [1..1]  The formatted Phone number. This data is not used in inbound requests. Any data provided for this attribute will be ignored.   
Country_ISO_Code  string (3)   [0..1]  Country ISO code. If the Country ISO code is specified, then this ISO code will be used to determine the Country Phone Code f or the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, Country Phone Code '1' is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica and Puerto Rico)   
International_Phone_Code  string  [0..1]  International Phone Code Number   
Area_Code  string  [0..1]  Area Code Number 
Validation Description
Enter an area code in the valid format: [AreaCodeValidationMessage]   
 
Phone_Number  string  [0..1]  Phone Number 
Validation Description
Enter a phone number in the valid format: [PhoneValidationMessage].   
 
Phone_Extension  string  [0..1]  Phone Extension   
Phone_Device_Type_Reference  Phone_Device_TypeObject  [0..1]  Reference ID for Phone Device Type.   
Usage_Data  Communication_Method_Usage_Information_Data  [1..*]  Encapsulating element for all Communication Method Usage data.   
Validation Description
Invalid Usage Type and Use For combination for Phone.  Invalid Usage Type and Use For combination for Phone. 
[country code] is not a valid country code for [country iso code]   
[country iso code] is not a valid country code   
You cannot specify the same usage type more than once for an address.   
Element Content 'Phone Number' is required, on internal element 'Phone Information Data'  Element Content 'Phone Number' is required, on internal element 'Phone Information Data' 
Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data'  Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data' 
Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data'  Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data' 
top
 

Phone_Device_TypeObject

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

Phone_Device_TypeObjectID

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

Email_Address_Information_Data

part of: Contact_Information_Data
Email Address Information
 
Parameter name Type/Value Cardinality Description Validations
Email_Address  string  [1..1]  Email Address Information 
Validation Description
Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com.   
 
Email_Comment  string  [0..1]  Email Comments.   
Usage_Data  Communication_Method_Usage_Information_Data  [1..*]  Encapsulating element for all Communication Method Usage data.   
Validation Description
Invalid Usage Type and Use For combination for Email Address.  Invalid Usage Type and Use For combination for Email Address. 
You cannot specify the same usage type more than once for an address.   
top
 

Instant_Messenger_Information_Data

part of: Contact_Information_Data
Instant Messenger Address.
 
Parameter name Type/Value Cardinality Description Validations
Instant_Messenger_Address  string  [1..1]  Instant Messenger Address.   
Instant_Messenger_Type_Reference  Instant_Messenger_TypeObject  [0..1]  Reference ID for the Instant Messenger Type. 
Validation Description
You must provide an Instant Messenger Type.   
 
Instant_Messenger_Comment  string  [0..1]  Instant Messenger Comment.   
Usage_Data  Communication_Method_Usage_Information_Data  [1..*]  Encapsulating element for all Communication Method Usage data.   
Validation Description
Invalid Usage Type and Use For combination for Instant Messenger Address.  Invalid Usage Type and Use For combination for Instant Messenger Address. 
You cannot specify the same usage type more than once for an address.   
top
 

Instant_Messenger_TypeObject

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

Instant_Messenger_TypeObjectID

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

Web_address_Information_Data

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

Admissions_Counselor_TypeObject

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

Admissions_Counselor_TypeObjectID

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

Prospect_Assignment_Criteria_Data

part of: Student_Recruiter_Data
Contains Prospect Assignment Criteria for a Student Recruiter.
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Criteria_Reference  Engagement_CriteriaObject  [0..1]  An Engagement Criteria instance for the Recruiter.   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  References an Academic Unit for a Recruiter's Prospect Assignment Criteria. 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  References an Academic Level for a Recruiter's Prospect Assignment Criteria.   
Region_Reference  RegionObject  [0..*]  References a Region for a Recruiter's Prospect Assignment Criteria.   
Student_Tag_Reference  Student_TagObject  [0..*]  References a Student Tag for a Recruiter's Prospect Assignment Criteria.   
Student_Prospect_Type_Reference  Student_Prospect_TypeObject  [0..*]  References a Student Type for a Recruiter's Prospect Assignment Criteria.   
Educational_Interest_Reference  Educational_InterestObject  [0..*]  References an Educational Interest for a Recruiter's Prospect Assignment Criteria.   
Location_Reference  LocationObject  [0..*]  References a Location for a Recruiter's Prospect Assignment Criteria.   
Validation Description
Prospect assignment criteria rows must be unique.   
top
 

Engagement_CriteriaObject

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

Engagement_CriteriaObjectID

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

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

Academic_Curricular_DivisionObjectID

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

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

RegionObject

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

RegionObjectID

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

Student_TagObject

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

Student_TagObjectID

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

Student_Prospect_TypeObject

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

Student_Prospect_TypeObjectID

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

Educational_InterestObject

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

Educational_InterestObjectID

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

LocationObject

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

Admissions_CounselorReferenceEnumeration

part of: Admissions_CounselorObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_Predefined_Person_Name_Component_ValueReferenceEnumeration

part of: Country_Predefined_Person_Name_Component_ValueObjectID
Base Type
string
top
 

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
 

Instant_Messenger_TypeReferenceEnumeration

part of: Instant_Messenger_TypeObjectID
Base Type
string
top
 

Admissions_Counselor_TypeReferenceEnumeration

part of: Admissions_Counselor_TypeObjectID
Base Type
string
top
 

Engagement_CriteriaReferenceEnumeration

part of: Engagement_CriteriaObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

RegionReferenceEnumeration

part of: RegionObjectID
Base Type
string
top
 

Student_TagReferenceEnumeration

part of: Student_TagObjectID
Base Type
string
top
 

Student_Prospect_TypeReferenceEnumeration

part of: Student_Prospect_TypeObjectID
Base Type
string
top
 

Educational_InterestReferenceEnumeration

part of: Educational_InterestObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top