Service Directory > v31.2 > Student_Recruiting > Put_Marketing_Activity_Definition
 

Operation: Put_Marketing_Activity_Definition

Creates a new Marketing Activity Definition (or updates an existing Marketing Activity Definition) 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_Marketing_Activity_Definition_Request

Wrapper element for the Put Marketing Activity Definition Request information
 
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.   
Marketing_Activity_Definition_Reference  Marketing_Activity_DefinitionObject  [0..1]  The reference to the Marketing Activity Definition being updated. For a new Marketing Activity Definition, this element will not exist.   
Marketing_Activity_Definition_Data  Marketing_Activity_Definition_Data  [1..1]  The wrapper element for Marketing Activity Definition data   
Validation Description
The Web Service is set to Add Only, but the Marketing Activity Definition already exists.   
top
 

Response Element: Put_Marketing_Activity_Definition_Response

Wrapper element for the data returned by Put Marketing Activity Definition
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Marketing_Activity_Definition_Reference  Marketing_Activity_DefinitionObject  [0..1]  The instance of the Marketing Activity Definition   
top
 

Marketing_Activity_DefinitionObject

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

Marketing_Activity_DefinitionObjectID

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

Marketing_Activity_Definition_Data

part of: Put_Marketing_Activity_Definition_Request
Contains all the data for the Put Marketing Activity Definition request
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for a Marketing Activity Definition   
Marketing_Activity_Definition_Name  string  [1..1]  The Name of the Marketing Activity Definition 
Validation Description
Enter a Name that isn't already in use.   
 
Student_Recruiting_Campaign_Reference  Student_Recruiting_CampaignObject  [1..1]  Reference to Student Recruiting Campaigns   
Marketing_Type_Reference  Marketing_TypeObject  [1..1]  Reference to a Marketing Type   
Marketing_Activity_Definition_Description  RichText  [0..1]  The Description for this Marketing Activity Definition   
Marketing_Activity_Definition_URL  string  [0..1]  The URL for this Marketing Activity Definition 
Validation Description
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
 
Marketing_Activity_Definition_Attachment_Data  Marketing_Activity_Definition_Attachment_Data  [0..*]  Contains attachment data for a Marketing Activity Definition   
top
 

Student_Recruiting_CampaignObject

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

Student_Recruiting_CampaignObjectID

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

Marketing_TypeObject

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

Marketing_TypeObjectID

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

Marketing_Activity_Definition_Attachment_Data

part of: Marketing_Activity_Definition_Data
Contains attachment data for a Marketing Activity Definition
 
Parameter name Type/Value Cardinality Description Validations
Marketing_Activity_Definition_Attachment_Reference  Marketing_Activity_Definition_AttachmentObject  [0..1]  The instance of the Marketing Activity Definition   
Attachment_WWS_Data  Attachment_WWS_Data  [0..*]  Attachment WWS Data element   
top
 

Marketing_Activity_Definition_AttachmentObject

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

Marketing_Activity_Definition_AttachmentObjectID

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

Attachment_WWS_Data

part of: Marketing_Activity_Definition_Attachment_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

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

Mime_TypeObjectID

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

Marketing_Activity_DefinitionReferenceEnumeration

part of: Marketing_Activity_DefinitionObjectID
Base Type
string
top
 

Student_Recruiting_CampaignReferenceEnumeration

part of: Student_Recruiting_CampaignObjectID
Base Type
string
top
 

Marketing_TypeReferenceEnumeration

part of: Marketing_TypeObjectID
Base Type
string
top
 

RichText

part of: Marketing_Activity_Definition_Data
Base Type
string
top
 

Marketing_Activity_Definition_AttachmentReferenceEnumeration

part of: Marketing_Activity_Definition_AttachmentObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top