Service Directory > v23.0 > Campus_Engagement > Put_Engagement_Email
 

Operation: Put_Engagement_Email

Creates or edits an Engagement Email using the information provided 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_Engagement_Email_Request

This element is a wrapper for all Engagement Email request data
 
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.   
Engagement_Email_Reference  Engagement_EmailObject  [0..1]  Engagement Email Reference   
Engagement_Email_Data  Engagement_Email_Data  [1..1]  Contains all References and Attributes for an Engagement Email   
Validation Description
The Web Service is set to Add Only, but the Engagement Email already exists.   
top
 

Response Element: Put_Engagement_Email_Response

Put Engagement Email Response wrapper element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Engagement_Email_Reference  Engagement_EmailObject  [0..1]  Engagement Email Reference   
top
 

Engagement_EmailObject

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

Engagement_EmailObjectID

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

Engagement_Email_Data

part of: Put_Engagement_Email_Request
Contains all References and Attributes for an Engagement Email
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Engagement Email Reference ID can be used to uniquely identify an Engagement Email   
Name  string  [1..1]  Name of the Engagement Item   
Description  RichText  [0..1]  Description of the Engagement Item   
Subject  string  [1..1]  Subject line for Engagement Email   
Message_Content  string  [1..1]  Content for the body of the Engagement Email   
Academic_Curricular_Division_Subedit_Data  Academic_Curricular_Division_Subedit_Data  [1..*]  Contains Academic Curricular Division information for a Student Prospect 
Validation Description
The Academic Curricular Division is not valid for the selected Academic Level   
 
top
 

Academic_Curricular_Division_Subedit_Data

part of: Engagement_Email_Data
Contains Academic Curricular Division information for a Student Prospect
 
Parameter name Type/Value Cardinality Description Validations
Academic_Level_Reference  Academic_LevelObject  [1..1]  References an Academic Level for a Student Prospect   
Academic_Curricular_Division_Reference  Academic_Curricular_DivisionObject  [1..1]  References an Academic Curricular Division for a Student Prospect   
Validation Description
The Academic Curricular Division is not valid for the selected Academic Level   
top
 

Academic_LevelObject

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

Academic_LevelObjectID

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

Academic_Curricular_DivisionObject

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

Academic_Curricular_DivisionObjectID

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

Engagement_EmailReferenceEnumeration

part of: Engagement_EmailObjectID
Base Type
string
top
 

RichText

part of: Engagement_Email_Data
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top