Service Directory > v32.1 > Workday_Connect > Get_Message_Template_Translation
 

Operation: Get_Message_Template_Translation

Retrieves all languages a message template has been translated to.


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

Retrieves translations for a message template.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Message_Template_Translation_Request_Reference  [0..*]  Stores a user's inputted message template instance.   
Request_Criteria  Message_Template_Translation_Request_Criteria  [0..*]  Defines the criteria of a message template translation request.   
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_Message_Template_Translation_Response

Reponse Element for Get Message Translation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Message_Template_Translation_Request_Criteria  Message_Template_Translation_Request_Criteria  [0..*]  Defines the criteria for a message template translation request.   
Message_Template_Translation_Request_Reference  Message_Template_Translation_Request_Reference  [0..*]  Reference to original request   
Response_Results  Response_Results  [0..*]  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  Message_Template_Translation_Response_Data  [0..*]  Retrieves all translated data for the message template you requested.   
Response_Filter  Response_Filter  [0..*]  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
 

Message_Template_Translation_Request_Reference

part of: Get_Message_Template_Translation_Response, Get_Message_Template_Translation_Request
This Request Element is used to get translations for Message Template
 
Parameter name Type/Value Cardinality Description Validations
Message_Template_Reference  Message_TemplateObject  [1..1]  Stores message template user input   
top
 

Message_TemplateObject

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

Message_TemplateObjectID

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

Message_Template_Translation_Request_Criteria

part of: Get_Message_Template_Translation_Response, Get_Message_Template_Translation_Request
This is the request criteria element for message template translations
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Message_Template_Translation_Response, Get_Message_Template_Translation_Request
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_Message_Template_Translation_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
 

Message_Template_Translation_Response_Data

part of: Get_Message_Template_Translation_Response
Subelement for the response of get message template translation
 
Parameter name Type/Value Cardinality Description Validations
Message_Template_Translation  Message_Template_Translation_Data  [0..*]  Returns User Language and Translations for User Language and Message Template   
top
 

Message_Template_Translation_Data

part of: Message_Template_Translation_Response_Data
Subelement to show Message Template Translations for User Language
 
Parameter name Type/Value Cardinality Description Validations
User_Language_Reference  User_LanguageObject  [1..1]  EC used to show user language returned in WS   
Message_Template_Translation_Data  Notification_Configuration_Translation_Data  [0..1]  Contains both the email and mobile notification translation data for web services   
top
 

User_LanguageObject

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

Notification_Configuration_Translation_Data

part of: Message_Template_Translation_Data
This element contains both the email and mobile notification translation data for web services
 
Parameter name Type/Value Cardinality Description Validations
Message_Template_Email_Translation_Response_Data  Email_Translation_Data  [0..1]  Returns translation data for the email aspect of the message template.   
Message_Template_Mobile_Notification_Translation_Response_Data  Mobile_Notification_Translation_Data  [0..1]  Returns translation data for the mobile notification aspect of the message template.   
top
 

Email_Translation_Data

part of: Notification_Configuration_Translation_Data
Returns email translation data.
 
Parameter name Type/Value Cardinality Description Validations
From_Display_Name_in_Target_Language  string  [0..1]  Returns the name of the sender in the target language you selected.   
Email_Subject_in_Target_Language  RichText  [0..1]  Returns the subject of the email in the target language you selected.   
Email_Body_in_Target_Langauge  RichText  [0..1]  Returns the body of the email in the target language you selected.   
top
 

Mobile_Notification_Translation_Data

part of: Notification_Configuration_Translation_Data
Returns translation data for the mobile notification aspect of the message template.
 
Parameter name Type/Value Cardinality Description Validations
Push_Notification_Message_in_Target_Language  RichText  [0..1]  Returns the content of the push notification in the target language you selected.   
top
 

Message_TemplateReferenceEnumeration

part of: Message_TemplateObjectID
Base Type
string
top
 

User_LanguageReferenceEnumeration

part of: User_LanguageObjectID
Base Type
string
top
 

RichText

part of: Email_Translation_Data, Email_Translation_Data, Mobile_Notification_Translation_Data
Base Type
string
top