Service Directory > v23.0 > Campus_Engagement > Put_Engagement_External_Item
 

Operation: Put_Engagement_External_Item

Creates or updates instances of Engagement External Item (i.e., Engagement Emails) 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_External_Item_Request

Put Engagement External Item Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Engagement_External_Item_Reference  Engagement_External_ItemObject  [0..1]  Engagement External Item instance reference   
Engagement_External_Item_Data  Engagement_External_Item_Data  [0..1]  Engagement External Item Data element   
Validation Description
Cannot edit an Existing Engagement External Item   
top
 

Response Element: Put_Engagement_External_Item_Response

Put Engagement External Item Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Engagement_External_Item_Reference  Engagement_External_ItemObject  [0..1]  Engagement External Item instance reference   
top
 

Engagement_External_ItemObject

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

Engagement_External_ItemObjectID

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

part of: Put_Engagement_External_Item_Request
Engagement External Item Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Parameter to set ID for Engagement External Item   
Name  string  [0..1]  Parameter to set Name for Engagement External Item   
Description  string  [0..1]  Parameter to set Description for Engagement External Item   
External_URL_Data  External_URL  [0..*]  Parameter to set URL(s) for Engagement External Item   
Recipients_Reference  Academic_PersonObject  [0..*]  Parameter to set Academic Persons who have recieved this Engagement External Item   
top
 

External_URL

part of: Engagement_External_Item_Data
This element represents an external URL
 
Parameter name Type/Value Cardinality Description Validations
External_URL_Reference  External_URLObject  [0..1]  Reference to an existing external URL   
External_URL_Data  External_URL_Data  [0..1]  Detail data for an external URL   
top
 

External_URLObject

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

External_URLObjectID

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

External_URL_Data

part of: External_URL
This element contains the details of an external URL.
 
Parameter name Type/Value Cardinality Description Validations
URL_Name  string  [0..1]  Name of external URL   
URL  string  [0..1]  Value of external URL (hyperlink)   
top
 

Academic_PersonObject

part of: Engagement_External_Item_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_External_ItemReferenceEnumeration

part of: Engagement_External_ItemObjectID
Base Type
string
top
 

External_URLReferenceEnumeration

part of: External_URLObjectID
Base Type
string
top
 

Academic_PersonReferenceEnumeration

part of: Academic_PersonObjectID
Base Type
string
top