Service Directory > v23.0 > Campus_Engagement > Put_Engagement_Conversation
 

Operation: Put_Engagement_Conversation

Creates or updates instances of Engagement Conversation 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_Conversation_Request

Put Engagement Conversation Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only flag for Engagement Conversation Request   
Engagement_Conversation_Reference  Engagement_ConversationObject  [0..1]  Engagement Conversation Request   
Engagement_Conversation_Data  Engagement_Conversation_Data  [1..1]  Engagement Conversation Data element   
Validation Description
The Web Service is set to Add Only, but the Engagement Conversation already exists.   
top
 

Response Element: Put_Engagement_Conversation_Response

Put Engagement Conversation Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Engagement_Conversation_Reference  Engagement_ConversationObject  [0..1]  Engagement Conversation reference   
top
 

Engagement_ConversationObject

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

Engagement_ConversationObjectID

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

part of: Put_Engagement_Conversation_Request
Engagement Conversation Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Engagement Conversation   
Entry_Date  dateTime  [1..1]  Record Date for Engagement Conversation 
Validation Description
Enter a Conversation Date that isn't in the future.   
 
Person_Reference  Academic_PersonObject  [1..1]  Person for Engagement Conversation   
Description  RichText  [1..1]  Description for Engagement Conversation   
Conversation_Topic_Reference  Engagement_Conversation_TopicObject  [0..*]  Conversation Topic for Engagement Conversation   
Initiated_by_Institution  boolean  [0..1]  Initiated by Institution flag for Engagement Conversation   
top
 

Academic_PersonObject

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

Academic_PersonObjectID

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

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

Engagement_Conversation_TopicObjectID

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

part of: Engagement_ConversationObjectID
Base Type
string
top
 

Academic_PersonReferenceEnumeration

part of: Academic_PersonObjectID
Base Type
string
top
 

RichText

part of: Engagement_Conversation_Data
Base Type
string
top
 

Engagement_Conversation_TopicReferenceEnumeration

part of: Engagement_Conversation_TopicObjectID
Base Type
string
top