Service Directory > v31.2 > Workday_Connect > Put_Message_Template
 

Operation: Put_Message_Template

Adds or updates message template with the information supplied in the request.


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

Contains all the request data to add or update a message template.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Message_Template_Reference  Message_TemplateObject  [0..1]  Unique Reference to the Message Template. Used to identify the Message Template to update. Leave blank on an Add.   
Message_Template_Data  Message_Template_Data  [1..1]  Data for a Message Template. 
Validation Description
External Field(s) are invalid. Please remove them before saving: [fields]   
 
Validation Description
The Web Service is set to Add Only; but the Message Template already exists.   
top
 

Response Element: Put_Message_Template_Response

Wrapper element for Put Notification Content response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Message_Template_Reference  Message_TemplateObject  [0..1]  Reference to a Message Template.   
top
 

Message_TemplateObject

part of: Put_Message_Template_Request, Put_Message_Template_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_Data

part of: Put_Message_Template_Request
Contains Notification Content data.
 
Parameter name Type/Value Cardinality Description Validations
Message_Template_ID  string  [0..1]  Unique identifier for the message template. If not entered, one will be generated.   
Message_Template_Name  string  [0..1]  Name for Message Template. 
Validation Description
A Message Template with the same name already exists. Please enter a new Message Template name.   
 
Notification_Type_Reference  Notification_CategoryObject  [0..1]  Notification Type for Message Template.   
Email_Notification_Configuration_Replacement_Data  Email_Notification_Configuration_Replacement_Data  [0..*]  Wrapper element for Email Message Template data.   
Push_Notification_Configuration_Replacement_Data  Push_Notification_Configuration_Replacement_Data  [0..*]  Wrapper element for Push Message Template data.   
Validation Description
External Field(s) are invalid. Please remove them before saving: [fields]   
top
 

Notification_CategoryObject

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

Notification_CategoryObjectID

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

Email_Notification_Configuration_Replacement_Data

part of: Message_Template_Data
Contains Email Notification data.
 
Parameter name Type/Value Cardinality Description Validations
Email_Subject_Reference  RichText  [1..1]  Subject for Email Notification.   
Email_From_Display_Name_Reference  string  [0..1]  Display Name for Email Notification.   
Email_Reply_To_Reference  string  [0..1]  Reply To for Email Notification.   
Email_Body_Reference  RichText  [1..1]  Body for Email Notification.   
top
 

Push_Notification_Configuration_Replacement_Data

part of: Message_Template_Data
Contains Push Notification data.
 
Parameter name Type/Value Cardinality Description Validations
Push_Message_Reference  RichText  [1..1]  Message for push notification.   
top
 

Message_TemplateReferenceEnumeration

part of: Message_TemplateObjectID
Base Type
string
top
 

Notification_CategoryReferenceEnumeration

part of: Notification_CategoryObjectID
Base Type
string
top
 

RichText

part of: Email_Notification_Configuration_Replacement_Data, Email_Notification_Configuration_Replacement_Data, Push_Notification_Configuration_Replacement_Data
Base Type
string
top