Service Directory > v31.2 > Human_Resources > Get_Preferred_Communication_Language
 

Operation: Get_Preferred_Communication_Language

Get Preferred Communication language configuration


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

Get Preferred Communication Language Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   User_Preferred_Communication_Language_References  [0..1]  User Preferred Communication Language References   
Request_Criteria [Choice]   User_Language_Setting_Request_Criteria  [0..1]  User Language Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  User_Language_Setting_Response_Group  [0..1]  User Language Response Group   
top
 

Response Element: Get_Preferred_Communication_Language_Response

Get Preferred Communication Language Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  User_Preferred_Communication_Language_References  [0..1]  User Preferred Communication Language References   
Request_Criteria  User_Language_Setting_Request_Criteria  [0..1]  User Language Setting Request   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  User_Language_Setting_Response_Group  [0..1]  User Language Setting Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Preferred_Communication_Language_Response_Data  [0..1]  Response Data   
top
 

User_Preferred_Communication_Language_References

part of: Get_Preferred_Communication_Language_Request, Get_Preferred_Communication_Language_Response
User Preferred Communication Language References
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [1..*]  Country Reference   
top
 

CountryObject

part of: Preferred_Communication_Languages, User_Preferred_Communication_Language_References
 
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
 

User_Language_Setting_Request_Criteria

part of: Get_Preferred_Communication_Language_Request, Get_Preferred_Communication_Language_Response
User Language Setting Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Preferred_Communication_Language_Request, Get_Preferred_Communication_Language_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
 

User_Language_Setting_Response_Group

part of: Get_Preferred_Communication_Language_Request, Get_Preferred_Communication_Language_Response
User Language Setting Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Preferred_Communication_Language_Response_Data

part of: Get_Preferred_Communication_Language_Response
Preferred Communication Language Response Data
 
Parameter name Type/Value Cardinality Description Validations
Preferred_Communication_Languages  Preferred_Communication_Languages  [0..*]  Preferred Communication Languages 
Validation Description
A country cannot be passed more than once in a single request.   
 
top
 

Preferred_Communication_Languages

part of: Preferred_Communication_Language_Response_Data
Preferred Communication Language
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  Delete Flag   
Country_Reference  CountryObject  [1..1]  Country Reference   
Preferred_Communication_Language_Data  Preferred_Communication_Language_Data  [1..1]  Preferred Communication Language Data   
Validation Description
A country cannot be passed more than once in a single request.   
top
 

Preferred_Communication_Language_Data

part of: Preferred_Communication_Languages
User Language Setting Data
 
Parameter name Type/Value Cardinality Description Validations
User_Language_Reference  User_LanguageObject  [1..*]  User Language Reference   
Inactive  boolean  [0..1]  Inactive Flag   
top
 

User_LanguageObject

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

User_LanguageObjectID

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

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

User_LanguageReferenceEnumeration

part of: User_LanguageObjectID
Base Type
string
top