Service Directory > v31.2 > Workday_Connect > Put_Message_Template_Translation
 

Operation: Put_Message_Template_Translation

Warning: Any existing translations will be overridden with new values in request. Used to add or edit translations on message template. A message template and user language is required, and all the translatable fields are optional.


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

Adds or updates Message Template translations for Message template and User Language
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Message_Template_Reference  Message_TemplateObject  [1..1]  Used to determine message template to add or edit translations   
Message_Template_Translation_Data  Message_Template_Translation_Data  [1..1]  Contains translation values for email and push   
top
 

Response Element: Put_Message_Template_Translation_Response

Response for Put Message Template Translation with Message Template and User Language
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Message_Template_Reference  Message_TemplateObject  [0..1]  Message Template used for Put Request   
User_Language_Reference  User_LanguageObject  [0..1]  User Language used for Put Request   
top
 

Message_TemplateObject

part of: Put_Message_Template_Translation_Request, Put_Message_Template_Translation_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  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_Data

part of: Put_Message_Template_Translation_Request
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, Put_Message_Template_Translation_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  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