Service Directory > v23.0 > Campus_Engagement > Put_Engagement_Plan
 

Operation: Put_Engagement_Plan

Creates or edits an Engagement Plan 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_Plan_Request

This element is a wrapper for all Engagement Plan 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_Plan_Reference  Engagement_PlanObject  [0..1]  Engagement Plan Reference   
Engagement_Plan_Data  Engagement_Plan_Data  [1..1]  Contains all References and Attributes for an Engagement Plan 
Validation Description
Select an Engagement item that isn't already in use in this plan.   
Select Send with Plan or Specify Schedule for the plan's first step.   
This Item is not valid for the selected Academic Curricular Division.   
This Recipient Academic Curricular Division is not valid for the Plan Academic Curricular Division.   
 
Validation Description
The Web Service is set to Add Only, but the Engagement Plan already exists.   
top
 

Response Element: Put_Engagement_Plan_Response

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

Engagement_PlanObject

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

Engagement_PlanObjectID

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

part of: Put_Engagement_Plan_Request
Contains all References and Attributes for an Engagement Plan
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Engagement Email Reference ID can be used to uniquely identify an Engagement Plan   
Name  string  [1..1]  Engagement Plan Name   
Description  RichText  [0..1]  Engagement Plan Description   
Start_Date  date  [1..1]  Engagement Plan Start Date 
Validation Description
Enter a Start Date that is before the plan's Stop Date.   
 
Stop_Date  date  [0..1]  Engagement Plan End Date   
Stage_Reference  Student_Prospect_StageObject  [0..*]  Student Prospect Stage for Engagement Plan   
Student_Tag_Reference  Student_TagObject  [0..*]  Student Tag   
Educational_Institution_Reference  Educational_InstitutionObject  [0..*]  Educational Institution for Engagement Plan   
Educational_Interest_Reference  Educational_InterestObject  [0..*]  Educational Interest for Engagement Plan   
Anticipated_Start_Date_Begin  date  [0..1]  Anticipated Start Date Begin for Engagement Plan   
Anticipated_Start_Date_End  date  [0..1]  Anticipated Start Date End for Engagement Plan 
Validation Description
Enter a Latest Anticipated Start Date that is on or after the Earliest Anticipated Start Date.   
 
Academic_Curricular_Division_Reference  Academic_Curricular_DivisionObject  [1..*]  Academic Curricular Division   
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level   
Region_Reference  RegionObject  [0..*]  Recruiting Region for Engagement Plan   
Country_Region_Reference  Country_RegionObject  [0..*]  Country Region (State) for Engagement Plan   
Zip_Code  string (5)   [0..1]  Zip Code for Engagement Plan   
Engagement_Plan_Data_Step_Subedit  Engagement_Plan_Data_Step_Subedit  [0..*]  Contains all References and Attributes in an Engagement Step 
Validation Description
Step has schedule type "Send with Plan," but a Start Date, Increment Amount or Date Interval was specified.   
Step has schedule type "Specify Schedule," but Increment Amount or Date Interval was specified.   
Step has schedule type "Relative to Prior Step," but a Start Date was specified.   
Start Date is required if step is set to schedule type "Specify Schedule."   
Increment Amount and Date Interval is required if step is set to schedule type "Relative to Prior Step."   
 
Academic_Curricular_Division_Subedit_Data  Academic_Curricular_Division_Subedit_Data  [1..1]  Academic Curricular Division Subedit Data element 
Validation Description
The Academic Curricular Division is not valid for the selected Academic Level   
 
Validation Description
Select an Engagement item that isn't already in use in this plan.   
Select Send with Plan or Specify Schedule for the plan's first step.   
This Item is not valid for the selected Academic Curricular Division.   
This Recipient Academic Curricular Division is not valid for the Plan Academic Curricular Division.   
top
 

Student_Prospect_StageObject

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

Student_Prospect_StageObjectID

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

Student_TagObject

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

Student_TagObjectID

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

Educational_InstitutionObject

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

Educational_InstitutionObjectID

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

Educational_InterestObject

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

Educational_InterestObjectID

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

Academic_LevelObject

part of: Academic_Curricular_Division_Subedit_Data, Engagement_Plan_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
 

RegionObject

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

RegionObjectID

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

Country_RegionObject

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

Country_RegionObjectID

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

part of: Engagement_Plan_Data
Contains all References and Attributes in an Engagement Step
 
Parameter name Type/Value Cardinality Description Validations
Order  string  [1..1]  The order in which the step takes place in the Engagement Plan   
Engagement_Item_Reference  Engagement_ItemObject  [1..1]  Engagement Item for Engagement Step   
Send_with_Plan [Choice]   boolean  [1..1]  Indicator that an Engagement Step will be sent when the plan is sent   
Specify_Schedule [Choice]   boolean  [1..1]  Indicator that an Engagement Step will run according to a schedule within the engagement plan   
Relative_to_Prior_Step [Choice]   boolean  [1..1]  Indicator that an Engagement Step is relative to the prior step   
Start_Date  date  [0..1]  Engagement Step Start Date 
Validation Description
The Start Date and Stop Date for an engagement item must be within the engagement plan's Start Date and Stop Date.   
Enter a Start Date for the engagement item that is before the item's Stop Date.   
 
Increment_by  decimal (3, 0) >0   [0..1]  Engagement Step Increment Amount 
Validation Description
Enter a Send After value that is greater than zero.   
 
Date_Interval_Reference  Date_IntervalObject  [0..1]  Date Interval for Engagement Step   
End_Date  date  [0..1]  Engagement Step End Date 
Validation Description
The Start Date and Stop Date for an engagement item must be within the engagement plan's Start Date and Stop Date.   
 
Validation Description
Step has schedule type "Send with Plan," but a Start Date, Increment Amount or Date Interval was specified.   
Step has schedule type "Specify Schedule," but Increment Amount or Date Interval was specified.   
Step has schedule type "Relative to Prior Step," but a Start Date was specified.   
Start Date is required if step is set to schedule type "Specify Schedule."   
Increment Amount and Date Interval is required if step is set to schedule type "Relative to Prior Step."   
top
 

Engagement_ItemObject

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

Engagement_ItemObjectID

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

Date_IntervalObject

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

Date_IntervalObjectID

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

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

Engagement_PlanReferenceEnumeration

part of: Engagement_PlanObjectID
Base Type
string
top
 

RichText

part of: Engagement_Plan_Data
Base Type
string
top
 

Student_Prospect_StageReferenceEnumeration

part of: Student_Prospect_StageObjectID
Base Type
string
top
 

Student_TagReferenceEnumeration

part of: Student_TagObjectID
Base Type
string
top
 

Educational_InstitutionReferenceEnumeration

part of: Educational_InstitutionObjectID
Base Type
string
top
 

Educational_InterestReferenceEnumeration

part of: Educational_InterestObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

RegionReferenceEnumeration

part of: RegionObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Engagement_ItemReferenceEnumeration

part of: Engagement_ItemObjectID
Base Type
string
top
 

Date_IntervalReferenceEnumeration

part of: Date_IntervalObjectID
Base Type
string
top