Service Directory > v31.2 > Campus_Engagement > Put_Engagement_Record
 

Operation: Put_Engagement_Record

Creates a new Engagement Record or one of its subclasses(or updates an existing Student Grading Scheme) 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_Engagement_Record_Request

Put Engagement Record Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Engagement_Record_Reference  Student_Engagement_Record_AbstractObject  [0..1]  Engagement Record Reference   
Engagement_Record_Data  Engagement_Record_Abstract_Data  [0..1]  Engagement Record Data 
Validation Description
An Engagement Event is Required when creating a Student Recruiting Event Engagement Record Instance.   
Engagement Email must have Engagement Email Assignment.   
Engagement Record Action must be either Email - Opened or Email - Bounced.   
 
Validation Description
"Add Only" is specified, but the Engagement Record already exists.   
top
 

Response Element: Put_Engagement_Record_Response

Put Engagement Record Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Engagement_Record_Reference  Student_Engagement_Record_AbstractObject  [0..1]  Engagement Record Abstract Reference   
Engagement_Record_Data  Engagement_Record_Abstract_Data  [0..*]  Engagement Record Data 
Validation Description
An Engagement Event is Required when creating a Student Recruiting Event Engagement Record Instance.   
Engagement Email must have Engagement Email Assignment.   
Engagement Record Action must be either Email - Opened or Email - Bounced.   
 
top
 

Student_Engagement_Record_AbstractObject

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

Student_Engagement_Record_AbstractObjectID

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

part of: Put_Engagement_Record_Request, Put_Engagement_Record_Response
Engagement Record Data Element
 
Parameter name Type/Value Cardinality Description Validations
Entry_Date  dateTime  [1..1]  Entry Date   
Correlation_ID  string  [0..1]  Correlation ID   
Has_Engagement_Record_Reference  Has_Engagement_RecordObject  [1..1]  Has Engagement Record Reference   
Prospect_Reference  StudentObject  [1..1]  Prospect Reference   
Engagement_Container_Reference  Student_Engagement_ContainerObject  [1..1]  Engagement Container Reference   
Engagement_Record_Action_Reference  Engagement_Record_ActionObject  [1..1]  Engagement Record Action Reference   
Validation Description
An Engagement Event is Required when creating a Student Recruiting Event Engagement Record Instance.   
Engagement Email must have Engagement Email Assignment.   
Engagement Record Action must be either Email - Opened or Email - Bounced.   
top
 

Has_Engagement_RecordObject

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

Has_Engagement_RecordObjectID

part of: Has_Engagement_RecordObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Advising_Note_ID, Academic_Record_Note_ID, Engagement_Action_Item_Assignment_ID, Engagement_Action_Item_ID, Engagement_Email_ID, Engagement_External_Item_ID, External_Engagement_Item_ID, Printed_Engagement_Item_ID, Student_Financial_Account_Note_ID, Student_Hold_Assignment_ID, Student_Note_ID, Student_Recruiting_Event_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
 

StudentObject

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

StudentObjectID

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

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

Student_Engagement_ContainerObjectID

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

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

Engagement_Record_ActionObjectID

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

part of: Student_Engagement_Record_AbstractObjectID
Base Type
string
top
 

Has_Engagement_RecordReferenceEnumeration

part of: Has_Engagement_RecordObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Student_Engagement_ContainerReferenceEnumeration

part of: Student_Engagement_ContainerObjectID
Base Type
string
top
 

Engagement_Record_ActionReferenceEnumeration

part of: Engagement_Record_ActionObjectID
Base Type
string
top