Service Directory > v32.1 > Student_Recruiting > Get_Marketing_Activity_Definitions
 

Operation: Get_Marketing_Activity_Definitions

Retrieves Marketing Activity Definitions by the Marketing Activity Definition Name or reference ID or returns all Marketing Activity Definitions if no reference ID is specified.


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

Wrapper element for Marketing Activity Definition Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Marketing_Activity_Definition_Request_References  [0..1]  Element containing the Marketing Activity Definitions for which data is requested   
Request_Criteria [Choice]   Marketing_Activity_Definition_Request_Criteria  [0..1]  Utilize the following criteria options to retrieve Marketing Activity Definitions within the Workday system   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Marketing_Activity_Definitions_Response

Get Response for Marketing Activity Definitions
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Marketing_Activity_Definition_Request_References  [0..1]  Element containing the Marketing Activity Definitions for which data is requested   
Request_Criteria  Marketing_Activity_Definition_Request_Criteria  [0..1]  Utilize the following criteria options to retrieve Marketing Activity Definitions within the Workday system   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Marketing_Activity_Definition_Response_Data  [0..1]  Contains the data to be returned when a Get request is submitted   
top
 

Marketing_Activity_Definition_Request_References

part of: Get_Marketing_Activity_Definitions_Request, Get_Marketing_Activity_Definitions_Response
Element containing the Marketing Activity Definitions for which data is requested
 
Parameter name Type/Value Cardinality Description Validations
Marketing_Activity_Definition_Reference  Marketing_Activity_DefinitionObject  [1..*]  Marketing Activity Definition references   
top
 

Marketing_Activity_DefinitionObject

part of: Marketing_Activity_Definition_Request_References, Marketing_Activity_Definition
 
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_Request_Criteria

part of: Get_Marketing_Activity_Definitions_Request, Get_Marketing_Activity_Definitions_Response
Utilize the following criteria options to retrieve Marketing Activity Definitions within the Workday system
 
Parameter name Type/Value Cardinality Description Validations
Marketing_Activity_Definition_Name  string  [0..1]  The Name of the Marketing Activity Definition to retrieve.   
top
 

Response_Filter

part of: Get_Marketing_Activity_Definitions_Request, Get_Marketing_Activity_Definitions_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
 

Response_Results

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

Marketing_Activity_Definition_Response_Data

part of: Get_Marketing_Activity_Definitions_Response
Contains the data to be returned when a Get request is submitted
 
Parameter name Type/Value Cardinality Description Validations
Marketing_Activity_Definition  Marketing_Activity_Definition  [0..*]  Contains the instance of the Marketing Activity Definition and the data to return in the response   
top
 

Marketing_Activity_Definition

part of: Marketing_Activity_Definition_Response_Data
Contains the instance of the Marketing Activity Definition and the data to return in the response
 
Parameter name Type/Value Cardinality Description Validations
Marketing_Activity_Definition_Reference  Marketing_Activity_DefinitionObject  [0..1]  The instance of the Marketing Activity Definition   
Marketing_Activity_Definition_Data  Marketing_Activity_Definition_Data  [0..*]  Contains all the data for the Put Marketing Activity Definition request   
top
 

Marketing_Activity_Definition_Data

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