Service Directory > v31.2 > Talent > Get_Languages
 

Operation: Get_Languages

This operation allows retrieval of language information.


@ - 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_Languages_Request

Top-level element for this operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Language_Request_References  [0..1]  Wrapper element for zero or more references.   
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_Languages_Response

Top-level element for this operation's response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Language_Request_References  [0..1]  Wrapper element for zero or more references.   
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  Language_Response_Data  [0..1]  Wrapper element for Language data.   
top
 

Language_Request_References

part of: Get_Languages_Request, Get_Languages_Response
Wrapper element for zero or more references.
 
Parameter name Type/Value Cardinality Description Validations
Language_Reference  LanguageObject  [1..*]  Reference ID to indicate a specific Language.   
top
 

LanguageObject

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

LanguageObjectID

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

Response_Filter

part of: Get_Languages_Request, Get_Languages_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_Languages_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
 

Language_Response_Data

part of: Get_Languages_Response
Wrapper element for Language data.
 
Parameter name Type/Value Cardinality Description Validations
Language  Language  [0..*]  Wrapper for Language Reference and Data elements.   
top
 

Language

part of: Language_Response_Data
Wrapper for Language Reference and Data elements.
 
Parameter name Type/Value Cardinality Description Validations
Language_Reference  LanguageObject  [0..1]  Wrapper for Reference ID, which indicates a specific Language.   
Language_Data  Language_Data  [0..*]  Encapsulating element containing all Language data. 
Validation Description
Enter a unique Language. A Language with that name already exists.   
 
top
 

Language_Data

part of: Language
Encapsulating element containing all Language data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the language.   
Language_Description  string  [1..1]  The description of the language   
Inactive  boolean  [0..1]  Indicates whether or not the language is active in the system, which allows users to select the language from prompts.   
Validation Description
Enter a unique Language. A Language with that name already exists.   
top
 

LanguageReferenceEnumeration

part of: LanguageObjectID
Base Type
string
top