Service Directory > v25.1 > Campus_Engagement > Get_Engagement_Conversations
 

Operation: Get_Engagement_Conversations

Retrieves Engagement Conversations by Tag or 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_Conversations_Request

Get Engagement Conversations Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Engagement_Conversation_Request_References  [0..1]  Engagement Conversation Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Engagement_Conversation_Response_Group  [0..1]  Engagement Conversation Response Group   
top
 

Response Element: Get_Engagement_Conversations_Response

Get Engagement Conversations Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Engagement_Conversation_Request_References  [0..1]  Engagement Conversation Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Engagement_Conversation_Response_Group  [0..1]  Engagement Conversation Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Engagement_Conversation_Response_Data  [0..1]  Engagement Conversation Response Data   
top
 

Engagement_Conversation_Request_References

part of: Get_Engagement_Conversations_Request, Get_Engagement_Conversations_Response
Engagement Conversation Request References
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Conversation_Reference  Engagement_ConversationObject  [1..*]  Engagement Conversation reference   
top
 

Engagement_ConversationObject

part of: Engagement_Conversation_Request_References, Engagement_Conversation
 
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
 

Response_Filter

part of: Get_Engagement_Conversations_Request, Get_Engagement_Conversations_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
 

Engagement_Conversation_Response_Group

part of: Get_Engagement_Conversations_Request, Get_Engagement_Conversations_Response
Engagement Conversation Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference flag   
top
 

Response_Results

part of: Get_Engagement_Conversations_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_Conversation_Response_Data

part of: Get_Engagement_Conversations_Response
Engagement Conversation Response Data
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Conversation  Engagement_Conversation  [0..*]  Engagement Conversation Response element   
top
 

Engagement_Conversation

part of: Engagement_Conversation_Response_Data
Engagement Conversation element
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Conversation_Reference  Engagement_ConversationObject  [0..1]  Engagement Conversation Reference returned   
Engagement_Conversation_Data  Engagement_Conversation_Data  [0..1]  Engagement Conversation Data   
top
 

Engagement_Conversation_Data

part of: Engagement_Conversation
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  StudentObject  [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
 

StudentObject

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

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
 

StudentReferenceEnumeration

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