Service Directory > v31.2 > Learning > Get_Extended_Enterprise_Learners
 

Operation: Get_Extended_Enterprise_Learners

Information about the specified Extended Enterprise Learners identified in the request. If the request doesn't specify the Extended Enterprise Learners to return, contains information for all External Learners in the system.


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

Contains references to find and get Extended Enterprise Learners and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Extended_Enterprise_Learner_Request_References  [0..1]  Retrieves specific instances of Extended Enterprise Learners and their associated data.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Extended_Enterprise_Learners_Response

Response containing data for requested Extended Enterprise Learner(s)
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Extended_Enterprise_Learner_Request_References  [0..1]  Retrieves specific instances of Extended Enterprise Learners and their associated data.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Extended_Enterprise_Learner_Response_Data  [0..1]  Data for requested Extended Enterprise Learner(s)   
top
 

Extended_Enterprise_Learner_Request_References

part of: Get_Extended_Enterprise_Learners_Request, Get_Extended_Enterprise_Learners_Response
Retrieves specific instances of Extended Enterprise Learners and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Extended_Enterprise_Learner_Reference  Extended_Enterprise_LearnerObject  [1..*]  References the Extended Enterprise Learners in the request.   
top
 

Extended_Enterprise_LearnerObject

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

Extended_Enterprise_LearnerObjectID

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

Response_Filter

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

Response_Results

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

Extended_Enterprise_Learner_Response_Data

part of: Get_Extended_Enterprise_Learners_Response
Contains Extended Enterprise Learner data for each request reference.
 
Parameter name Type/Value Cardinality Description Validations
Extended_Enterprise_Learner  Extended_Enterprise_Learner  [0..*]  Contains Extended Enterprise Learner data for each request reference.   
top
 

Extended_Enterprise_Learner

part of: Extended_Enterprise_Learner_Response_Data
Contains Extended Enterprise Learner data for each request reference.
 
Parameter name Type/Value Cardinality Description Validations
Extended_Enterprise_Learner_Reference  Extended_Enterprise_LearnerObject  [0..1]  Reference for an Extended Enterprise Learner.   
Extended_Enterprise_Learner_Data  Extended_Enterprise_Learner_Data  [0..*]  Account info for Extended Enterprise Learner 
Validation Description
A valid email address must be provided   
 
top
 

Extended_Enterprise_Learner_Data

part of: Extended_Enterprise_Learner
Contains detailed information about an Extended Enterprise Learner.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Extended Enterprise Learner   
Legal_Name_Data  Legal_Name_Data  [0..1]  Contains the legal name for a person. A person must name one and only one legal name. 
Validation Description
Legal Name Data must be provided.   
 
Email_Address  string  [0..1]  Email Address of Extended Enterprise Learner. 
Validation Description
A valid email address must be provided   
This email address is already in use. Do not duplicate people in the system.   
 
System_User_for_Extended_Enterprise_Learner_Data  System_User_for_Extended_Enterprise_Learner_Data  [1..1]  Info for System Account for Extended Enterprise Learner 
Validation Description
The User Name entered has invalid character: ":" or ";".   
The entered User Name is longer than the current tenant maximum. The tenant max is set to [max].   
You must send email notifications when creating a new Enabled Extended Enterprise Learner.   
You cannot send an email to an Extended Enterprise Learner that is Disabled.   
 
Extended_Enterprise_Affiliation_Reference  Extended_Enterprise_AffiliationObject  [1..1]  Affiliation for Extended Enterprise Affiliation.   
Photo_Data  Extended_Enterprise_Learner_Photo_Data  [0..1]  Photo Data for Extended Enterprise Learner.   
Validation Description
A valid email address must be provided   
top
 

Legal_Name_Data

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

CountryObject

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

CountryObjectID

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

Person_Name_Prefix_Data

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

Country_Predefined_Person_Name_Component_ValueObject

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

Country_Predefined_Person_Name_Component_ValueObjectID

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

Local_Person_Name_Detail_Data

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

Person_Name_Suffix_Data

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

System_User_for_Extended_Enterprise_Learner_Data

part of: Extended_Enterprise_Learner_Data
Information related to system account for Extended Enterprise Learner.
 
Parameter name Type/Value Cardinality Description Validations
System_User_Name_for_Person_in_Role  string  [0..1]  User Name for Extended Enterprise Learner 
Validation Description
Enter a User Name that isn't already in use.   
A User Name must be provided.   
The User Name cannot be changed.   
 
Account_Expiration_Date [Choice]   dateTime  [0..1]  Account Expiration Date for Extended Enterprise Learner 
Validation Description
Account Expiration Date cannot be in the past.   
 
Account_Disabled [Choice]   boolean  [0..1]  Whether the Extended Enterprise Learner's account is disabled.   
Send_Email_Notification_for_Username  boolean  [0..1]  Used to control sending an Extended Enterprise Learner their username in an email.   
Send_Email_Notification_for_Password  boolean  [0..1]  Used to control generating a random password and sending it to an Extended Enterprise Learner in an email.   
Validation Description
The User Name entered has invalid character: ":" or ";".   
The entered User Name is longer than the current tenant maximum. The tenant max is set to [max].   
You must send email notifications when creating a new Enabled Extended Enterprise Learner.   
You cannot send an email to an Extended Enterprise Learner that is Disabled.   
top
 

Extended_Enterprise_AffiliationObject

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

Extended_Enterprise_AffiliationObjectID

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

Extended_Enterprise_Learner_Photo_Data

part of: Extended_Enterprise_Learner_Data
Photo Data for Extended Enterprise Learner.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [0..1]  Name of Image file.   
File  base64Binary  [0..1]  Image file.   
top
 

Extended_Enterprise_LearnerReferenceEnumeration

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

Extended_Enterprise_AffiliationReferenceEnumeration

part of: Extended_Enterprise_AffiliationObjectID
Base Type
string
top