Service Directory > v23.0 > Campus_Engagement > Get_Engagement_Emails
 

Operation: Get_Engagement_Emails

Retrieves Engagement Emails by reference.


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

This element is the top-level request element for all "Get" Engagement Emails operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Engagement_Email_Request_References  [0..1]  Element containing reference instances for an Engagement Email   
Request_Criteria [Choice]   Engagement_Email_Request_Criteria  [0..1]  Element used to request Engagement Emails with specific criteria   
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_Engagement_Emails_Response

Top-level response element for all "Get" Engagement Emails operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Engagement_Email_Request_References  [0..1]  Element containing reference instances for an Engagement Email   
Request_Criteria  Engagement_Email_Request_Criteria  [0..1]  Element used to request Engagement Emails with specific criteria   
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. 
 
Response_Results  Response_Results  [0..1]  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  Engagement_Email_Response_Data  [0..1]  Wrapper element that contains the Engagement Email data elements that are included in the response   
top
 

Engagement_Email_Request_References

part of: Get_Engagement_Emails_Request, Get_Engagement_Emails_Response
Element containing reference instances for an Engagement Email
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Email_Reference  Engagement_EmailObject  [1..*]  Engagement Email Reference   
top
 

Engagement_EmailObject

part of: Engagement_Email_Request_References, Engagement_Email
 
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_Request_Criteria

part of: Get_Engagement_Emails_Request, Get_Engagement_Emails_Response
Element used to request Engagement Emails with specific criteria
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Item_Name  string  [0..1]  Used to request an Engagement Email by the Engagement Item Name   
top
 

Response_Filter

part of: Get_Engagement_Emails_Request, Get_Engagement_Emails_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
 

Response_Results

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

Engagement_Email_Response_Data

part of: Get_Engagement_Emails_Response
Wrapper element that contains the Engagement Email data elements that are included in the response
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Email  Engagement_Email  [0..*]  This element is the wrapper element for all Engagement Email data   
top
 

Engagement_Email

part of: Engagement_Email_Response_Data
This element is the wrapper element for all Engagement Email data
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Email_Reference  Engagement_EmailObject  [0..1]  Engagement Email Reference   
Engagement_Email_Data  Engagement_Email_Data  [0..1]  Contains all References and Attributes for an Engagement Email   
top
 

Engagement_Email_Data

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