Service Directory > v31.2 > Student_Recruiting > Get_Student_Recruiting_Events
 

Operation: Get_Student_Recruiting_Events

Returns Student Recruiting Events based on Event names, or returns all instances of Student Recruiting Events if Name Criteria is not 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_Student_Recruiting_Events_Request

Creates request to return specific instances of Student Recruiting Event. Can request by Event Name
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Recruiting_Event_Request_References  [0..1]  Returns references based on specified request criteria of Student Recruiting Events   
Request_Criteria [Choice]   Student_Recruiting_Event_Request_Criteria  [0..1]  Specific request criteria (Event name) can be specified here to request unique Student Recruiting Event. If Event Name is not specified, then all instances of Student Recruiting Event will be returned   
Response_Filter  Response_Filter  [0..1]  References Student Recruiting Event in "get" task 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Recruiting_Events_Response

Returns response based on request element. Returns Student Recruiting Events based on criteria specified in Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Recruiting_Event_Request_References  [0..1]  Contains specific references to request Student Recruiting Events   
Request_Criteria  Student_Recruiting_Event_Request_Criteria  [0..1]  Specifies Request Criteria for returning a set of Student Recruiting Events   
Response_Filter  Response_Filter  [0..1]  References Student Recruiting Event in "get" task 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Returns Student Recruiting Event data based on what is specified in Request Criteria   
Response_Data  Student_Recruiting_Event_Response_Data  [0..1]  Contains returned data on Student Recruiting Event based on Request Criteria specified   
top
 

Student_Recruiting_Event_Request_References

part of: Get_Student_Recruiting_Events_Request, Get_Student_Recruiting_Events_Response
Returns references based on specified request criteria of Student Recruiting Events
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Event_Reference  Student_Recruiting_EventObject  [1..*]  Work set of request references for Student Recruiting Events   
top
 

Student_Recruiting_EventObject

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

Student_Recruiting_EventObjectID

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

Student_Recruiting_Event_Request_Criteria

part of: Get_Student_Recruiting_Events_Request, Get_Student_Recruiting_Events_Response
Specific request criteria (Event name or Event Target Status) can be specified here to request unique Student Recruiting Event. If Event Name or Event Target Status is not specified, then all instances of Student Recruiting Event will be returned.
 
Parameter name Type/Value Cardinality Description Validations
Event_Name  string  [0..1]  Can use Event Name to specify certain instances of Student Recruiting Event   
Event_Status  string  [0..1]  Can use Event Target Status to specify certain instances of Student Recruiting Event   
top
 

Response_Filter

part of: Get_Student_Recruiting_Events_Request, Get_Student_Recruiting_Events_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_Student_Recruiting_Events_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
 

Student_Recruiting_Event_Response_Data

part of: Get_Student_Recruiting_Events_Response
Data Response based on specified Request criteria in Request element
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Event  Student_Recruiting_Event  [0..*]  Returns information for Student Recruiting Event   
top
 

Student_Recruiting_Event

part of: Student_Recruiting_Event_Response_Data
References Student Recruiting Event in "get" and "put" tasks
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Event_Reference  Student_Recruiting_EventObject  [0..1]  "Get" and "Put" web services   
Student_Recruiting_Event_Data  Student_Recruiting_Event_Data  [0..1]  References Student Recruiting Event in "get" task 
Validation Description
Enter an End Date that is on or after the Start Date.   
Please select an Engagement Invite Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Please select an Engagement Follow Up Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Please select an Engagement Registration Confirmation Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Enter a Stop Date for the invite item that is on or before the event End Date.   
Student Recruiting Event is not "Approved". Please enter a Recruiting Event with a status of "Approved"   
Send to Email Priority must be specified.   
You must enter a Category of Student Recruiting for student audiences.   
You must select an Audience with Invite Items.   
You must select an Invite Item for Audiences.   
You must select a Used For of Event - Invitation for student audiences.   
The audience you select must have the same academic unit or subordinate academic unit as your recruiting cycle.   
 
top
 

Student_Recruiting_Event_Data

part of: Student_Recruiting_Event
Contains returned data on Student Recruiting Event based on Request Criteria specified
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Recruiting Event Data   
Event_Name  string  [1..1]  Specifies name of Student Recruiting Event 
Validation Description
Enter a unique combination of Name, Start Date, and starting time for the recruiting event.   
 
Start_Date  dateTime  [1..1]  Specifies date of Student Recruiting Event 
Validation Description
Enter a unique combination of Name, Start Date, and starting time for the recruiting event.   
Enter a Start Date that is on or after the Campaign Start Date.   
Enter a Start Date that is on or before the Campaign End Date.   
 
End_Date  dateTime  [0..1]  References the End Date for a Student Recruiting Event 
Validation Description
Enter an End Date that is on or before the Campaign End Date.   
 
Time_Zone_Reference  Time_ZoneObject  [0..1]  References a Time Zone for a Student Recruiting Event   
On-Campus  boolean  [0..1]  References whether or not the Student Recruiting Event is On-Campus   
Description  RichText  [0..1]  Specifies Description of Student Recruiting Event   
External_Description  RichText  [0..1]  Specifies External Description of Public Student Recruiting Event   
Event_Owner_Reference  Admissions_CounselorObject  [1..1]  Specifies Owner (Student Recruiter) of Student Recruiting Event 
Validation Description
The Student Recruiting Event Date range is not within the assigned Recruiter's date range.  The Student Recruiting Event Date range is not within the assigned Recruiter's date range. 
 
Campaign_Reference  Student_Recruiting_CampaignObject  [1..1]  Specifies Campaign that Student Recruiting Event is associated with   
Location_Reference  Student_Recruiting_Event_LocationObject  [0..1]  References a Location for a Student Recruiting Event   
Event_Type_Reference  Student_Recruiting_Event_TypeObject  [1..1]  Specifies type of Student Recruiting Event   
Staff_Recruiter_Reference  Admissions_CounselorObject  [0..*]  Specifies Resources (Student Recruiters) for Student Recruiting Event   
Currency_Reference  CurrencyObject  [1..1]  Specifies Currency type for Budget of Student Recruiting Event   
Budget  decimal (14, 2) >0   [0..1]  Specifies Budget amount of Student Recruiting Event   
Planned_Attendance  decimal (12, 0) >0   [0..1]  Specifies expected attendance of Student Recruiting Event   
Private_Event  boolean  [0..1]  Specifies the visibility of Student Recruiting Event   
Host_Contact_Reference  Academic_ContactObject  [0..1]  Specifies the Host Contact of Student Recruiting Event   
Host_Location_Reference  Student_Recruiting_Event_LocationObject  [0..1]  Specifies the Host Location Reference of Student Recruiting Event   
Registration_Details_Data  Registration_Details_Data  [0..1]  Registration Details element of Student Recruiting Event 
Validation Description
An Attendance Limit is required for the Recruiting Event or specify No Limit.   
Since the Recruiting Event is not private, please provide an Academic Unit and Academic Level with a Configuration that is configured to Recruit Students.   
Please provide a value for Guests Per Prospect since Guests are Allowed for this event.   
Private Events don't allow Academic Units and Academic Levels to be submitted.   
Registration Close Date is before the Registration Start Date.   
Please provide both a Registration Opens Interval Amount and Registration Opens Date Interval or neither.   
Please provide both a Registration Closes Interval Amount and Registration Closes Date Interval or neither.   
 
Student_Recruiting_Event_Engagement_Data  Student_Recruiting_Event_Engagement_Data  [0..*]  Student Recruiting Event Engagement Data of Student Recruiting Event 
Validation Description
Send After amount is required if Followup Engagement item is specified.   
Date Interval required if Followup Item specified.   
Follow Up Item is Required if Follow Up Date Interval is specified   
Follow Up Item is Required if Follow Up Increment Amount is specified   
Enter an invite item Stop Date that is on or after the item's Start Date.   
Send to Email Priorities must be unique.   
Communication Order Type Values must be unique for Send to Email Priorities.   
Please provide an Engagement Invite Item that has been Approved or is Approved with a Pending Update.   
Please provide an Engagement item for the Invite item that has an Engagement Category of Event - Invite.   
Please provide an Engagement item for the Registration Confirmation item that has an Engagement Category of Event - Registration Confirmation.   
Please provide an Engagement Registration Confirmation Item that has been Approved or is Approved with a Pending Update.   
Invite Item Stop Date Interval required if Invite Stop Date Increment Amount is specified   
Invite Item Start Date Increment Amount required if Invite Start Date Interval is specified   
Invite Stop Date is required if Invite Item is specified and Invite Start Increment and Invite Start Date Interval are not specified   
Invite Item Required if Invite Start Date or Invite Start Date Increment and Invite Start Date Interval is specified   
Invite Start Date or Invite Start Date Increment and Invite Start Date Interval required if Invite Item specified.   
Invite Item Start Date Interval required if Invite Start Date Increment Amount is specified   
Invite Item Stop Date Increment Amount required if Invite Stop Date Interval is specified   
Enter an invite item Stop Date Increment Amount and Stop Date Interval that are after the Start Date Increment Amount and Start Date Interval.   
Invite Item Required if Invite Stop Date or Invite Stop Date Increment and Invite Stop Date Interval specified   
Please provide only Invite Start Date and Invite Stop Date or Invite Start Increment Amount, Invite Start Date Interval Reference, Invite Stop Increment Amount, and Invite Stop Date Interval Reference.   
 
Student_Audience_Reference  Dynamic_Engagement_Plan_Population__Student_Object  [0..1]  Student Audience replaces Engagement Criteria on a Recruiting Event. Student Audience is the population invited to a recruiting event.   
Validation Description
Enter an End Date that is on or after the Start Date.   
Please select an Engagement Invite Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Please select an Engagement Follow Up Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Please select an Engagement Registration Confirmation Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Enter a Stop Date for the invite item that is on or before the event End Date.   
Student Recruiting Event is not "Approved". Please enter a Recruiting Event with a status of "Approved"   
Send to Email Priority must be specified.   
You must enter a Category of Student Recruiting for student audiences.   
You must select an Audience with Invite Items.   
You must select an Invite Item for Audiences.   
You must select a Used For of Event - Invitation for student audiences.   
The audience you select must have the same academic unit or subordinate academic unit as your recruiting cycle.   
top
 

Time_ZoneObject

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

Time_ZoneObjectID

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

Admissions_CounselorObject

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

Admissions_CounselorObjectID

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

Student_Recruiting_CampaignObject

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

Student_Recruiting_Event_LocationObject

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

Student_Recruiting_Event_LocationObjectID

part of: Student_Recruiting_Event_LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Educational_Institution_CCD_ID, Educational_Institution_ID, Educational_Institution_Postsecondary_CEEB_ATP_ID, Educational_Institution_Postsecondary_Federal_ID, Educational_Institution_Postsecondary_IPEDS_ID, Educational_Institution_Postsecondary_Local_ID, Educational_Institution_Postsecondary_OPEID_ID, Educational_Institution_Postsecondary_Other_ID, Educational_Institution_Postsecondary_State_ID, Educational_Institution_Secondary_CEEB_ATP_ID, Educational_Institution_Secondary_Local_ID, Educational_Institution_Secondary_NCES_ID, Educational_Institution_Secondary_Other_ID, Educational_Institution_Secondary_State_ID, External_Association_ID, Location_ID, Student_Recruiting_Event_Ad_Hoc_Location_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
 

Student_Recruiting_Event_TypeObject

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

Student_Recruiting_Event_TypeObjectID

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

CurrencyObject

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

CurrencyObjectID

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

Academic_ContactObject

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

Academic_ContactObjectID

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

Registration_Details_Data

part of: Student_Recruiting_Event_Data
Registration Details Data Element
 
Parameter name Type/Value Cardinality Description Validations
No_Limit  boolean  [0..1]  Indicates limit for Attendance at Student Recruiting Event   
Total_Attendance_Limit  decimal (12, 0) >0   [0..1]  Total Attendance Limit for Student Recruiting Event   
Allow_Guests  boolean  [0..1]  Indicates if guests are allowed at Student Recruiting Event   
Guests_Per_Prospect  decimal (12, 0) >0   [0..1]  Number of Guests Per Prospect at Student Recruiting Event   
Registration_Opens  decimal (12, 0) >0   [0..1]  Increment for Engagement before/after Student Recruiting Event Registration Opens   
Open_Date_Interval_Reference  Date_IntervalObject  [0..1]  References Registration Open Date Interval   
Registration_Closes  decimal (12, 0) >0   [0..1]  Increment for Engagement before/after Student Recruiting Event Closes   
Close_Date_Interval_Reference  Date_IntervalObject  [0..1]  References Registration Close Date Interval   
Academic_Level_Reference  Academic_LevelObject  [0..1]  Academic Level for Default Recruitment   
Academic_Unit_Reference  Academic_UnitObject  [0..1]  Academic Unit for Default Recruitment   
Validation Description
An Attendance Limit is required for the Recruiting Event or specify No Limit.   
Since the Recruiting Event is not private, please provide an Academic Unit and Academic Level with a Configuration that is configured to Recruit Students.   
Please provide a value for Guests Per Prospect since Guests are Allowed for this event.   
Private Events don't allow Academic Units and Academic Levels to be submitted.   
Registration Close Date is before the Registration Start Date.   
Please provide both a Registration Opens Interval Amount and Registration Opens Date Interval or neither.   
Please provide both a Registration Closes Interval Amount and Registration Closes Date Interval or neither.   
top
 

Date_IntervalObject

part of: Student_Recruiting_Event_Engagement_Data, Student_Recruiting_Event_Engagement_Data, Student_Recruiting_Event_Engagement_Follow_Up_Data, Registration_Details_Data, Registration_Details_Data, Student_Recruiting_Event_Engagement_Pre_Event_Reminder_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  Date_IntervalObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Date_IntervalObjectID

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

Academic_LevelObject

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

Academic_LevelObjectID

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

Academic_UnitObject

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

Academic_UnitObjectID

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

Student_Recruiting_Event_Engagement_Data

part of: Student_Recruiting_Event_Data
Engagement Communication Details element
 
Parameter name Type/Value Cardinality Description Validations
Send_To_Email_Priority_Data  Engagement_Communication_Usage_Type_Order_Data  [1..*]  Contains Send to Email Priority Information 
Validation Description
Send Email To can only be set to Home, Work or Institutional.   
 
Invite_Item_Reference  Student_Engagement_ItemObject  [0..1]  Invite Item for Student Recruiting Event   
Invite_Start_Date  date  [0..1]  Invite Start Date for Student Recruiting Event   
Invite_Stop_Date  date  [0..1]  Invite End Date for Student Recruiting Event   
Invite_Start_Increment_Amount  decimal (12, 0) >0   [0..1]  Invite Start Date Increment Amount for Student Recruiting Event   
Invite_Start_Date_Interval_Reference  Date_IntervalObject  [0..1]  Invite Start Date Interval for Student Recruiting Event   
Invite_Stop_Increment_Amount  decimal (12, 0) >0   [0..1]  Invite Stop Date Increment Amount for Student Recruiting Event   
Invite_Stop_Date_Interval_Reference  Date_IntervalObject  [0..1]  Invite Stop Date Interval for Student Recruiting Event   
Student_Recruiting_Event_Engagement_Pre_Event_Reminder_Data  Student_Recruiting_Event_Engagement_Pre_Event_Reminder_Data  [0..*]  Engagement Pre Event Reminder Data for Student Recruiting Event 
Validation Description
Please select a Send To that is valid for Pre Event Reminders.   
Please provide a Student Engagement Item that is Approved or Approved with pending update.   
Please select an Engagement Reminder Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Please provide an Engagement Item that has an Engagement Category of Event Reminder.   
 
Student_Recruiting_Event_Engagement_Follow_Up_Data  Student_Recruiting_Event_Engagement_Follow_Up_Data  [0..*]  Engagement Follow Up Data for Student Recruiting Event 
Validation Description
Please select a Send To that's valid for Post Event Follow Up.   
Please provide an Engagement Item that has an Engagement Category of Event Follow Up.   
Please select an Engagement Follow Up Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Please provide an Engagement Follow Up Item that has been Approved or is Approved with a Pending Update   
Please provide an Engagement item for the Follow Up item that has an Engagement Category of Event - FollowUp.   
 
Registration_Confirmation_Item_Reference  Student_Engagement_ItemObject  [0..1]  Registration Confirmation Item for Student Recruiting Event   
Validation Description
Send After amount is required if Followup Engagement item is specified.   
Date Interval required if Followup Item specified.   
Follow Up Item is Required if Follow Up Date Interval is specified   
Follow Up Item is Required if Follow Up Increment Amount is specified   
Enter an invite item Stop Date that is on or after the item's Start Date.   
Send to Email Priorities must be unique.   
Communication Order Type Values must be unique for Send to Email Priorities.   
Please provide an Engagement Invite Item that has been Approved or is Approved with a Pending Update.   
Please provide an Engagement item for the Invite item that has an Engagement Category of Event - Invite.   
Please provide an Engagement item for the Registration Confirmation item that has an Engagement Category of Event - Registration Confirmation.   
Please provide an Engagement Registration Confirmation Item that has been Approved or is Approved with a Pending Update.   
Invite Item Stop Date Interval required if Invite Stop Date Increment Amount is specified   
Invite Item Start Date Increment Amount required if Invite Start Date Interval is specified   
Invite Stop Date is required if Invite Item is specified and Invite Start Increment and Invite Start Date Interval are not specified   
Invite Item Required if Invite Start Date or Invite Start Date Increment and Invite Start Date Interval is specified   
Invite Start Date or Invite Start Date Increment and Invite Start Date Interval required if Invite Item specified.   
Invite Item Start Date Interval required if Invite Start Date Increment Amount is specified   
Invite Item Stop Date Increment Amount required if Invite Stop Date Interval is specified   
Enter an invite item Stop Date Increment Amount and Stop Date Interval that are after the Start Date Increment Amount and Start Date Interval.   
Invite Item Required if Invite Stop Date or Invite Stop Date Increment and Invite Stop Date Interval specified   
Please provide only Invite Start Date and Invite Stop Date or Invite Start Increment Amount, Invite Start Date Interval Reference, Invite Stop Increment Amount, and Invite Stop Date Interval Reference.   
top
 

Engagement_Communication_Usage_Type_Order_Data

part of: Student_Recruiting_Event_Engagement_Data
Contains Send to Email Priority Information
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Communication_Usage_Type_Order_Value  string  [1..1]  Priority of email type   
Communication_Usage_Type_Reference  Communication_Usage_TypeObject  [1..1]  Email Type   
Validation Description
Send Email To can only be set to Home, Work or Institutional.   
top
 

Communication_Usage_TypeObject

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

Communication_Usage_TypeObjectID

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

Student_Engagement_ItemObject

part of: Student_Recruiting_Event_Engagement_Data, Student_Recruiting_Event_Engagement_Data, Student_Recruiting_Event_Engagement_Follow_Up_Data, Student_Recruiting_Event_Engagement_Pre_Event_Reminder_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_Engagement_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Engagement_ItemObjectID

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

Student_Recruiting_Event_Engagement_Pre_Event_Reminder_Data

part of: Student_Recruiting_Event_Engagement_Data
Student Recruiting Event Pre Event Reminder Data for Student Recruiting Event
 
Parameter name Type/Value Cardinality Description Validations
Send_To_Reference  Student_Recruiting_Event_Send_ToObject  [1..1]  Send To for Pre Event Reminder   
Pre_Event_Reminder_Item_Reference  Student_Engagement_ItemObject  [1..1]  Engagement Item for Pre Event Reminder   
Send_Before  decimal (12, 0) >0   [1..1]  Interval Amount for Pre Event Reminder   
Date_Interval_Reference  Date_IntervalObject  [1..1]  Date Interval for Pre Event Reminder   
Validation Description
Please select a Send To that is valid for Pre Event Reminders.   
Please provide a Student Engagement Item that is Approved or Approved with pending update.   
Please select an Engagement Reminder Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Please provide an Engagement Item that has an Engagement Category of Event Reminder.   
top
 

Student_Recruiting_Event_Send_ToObject

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

Student_Recruiting_Event_Send_ToObjectID

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

Student_Recruiting_Event_Engagement_Follow_Up_Data

part of: Student_Recruiting_Event_Engagement_Data
Student Recruiting Event Follow Up Data for Student Recruiting Event
 
Parameter name Type/Value Cardinality Description Validations
Follow_Up_Item_Container_Reference  Unique_IdentifierObject  [0..1]  Follow Up Item Container for Student Recruiting Event   
Send_To_Reference  Student_Recruiting_Event_Send_ToObject  [1..1]  Follow Up Send to for Follow Up Item Container   
Follow_Up_Item_Reference  Student_Engagement_ItemObject  [1..1]  Engagement Item for Follow Up Item Container   
Send_After  decimal (12, 0) >0   [1..1]  Send After Amount for Follow Up Item Container   
Date_Interval_Reference  Date_IntervalObject  [1..1]  Date Interval for Follow Up Item Container   
Validation Description
Please select a Send To that's valid for Post Event Follow Up.   
Please provide an Engagement Item that has an Engagement Category of Event Follow Up.   
Please select an Engagement Follow Up Item that has an Academic Unit that matches the Academic Unit of the Recruiting Cycle for the Student Recruiting Event.   
Please provide an Engagement Follow Up Item that has been Approved or is Approved with a Pending Update   
Please provide an Engagement item for the Follow Up item that has an Engagement Category of Event - FollowUp.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Dynamic_Engagement_Plan_Population__Student_Object

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

Dynamic_Engagement_Plan_Population__Student_ObjectID

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

Student_Recruiting_EventReferenceEnumeration

part of: Student_Recruiting_EventObjectID
Base Type
string
top
 

Time_ZoneReferenceEnumeration

part of: Time_ZoneObjectID
Base Type
string
top
 

RichText

part of: Student_Recruiting_Event_Data, Student_Recruiting_Event_Data
Base Type
string
top
 

Admissions_CounselorReferenceEnumeration

part of: Admissions_CounselorObjectID
Base Type
string
top
 

Student_Recruiting_CampaignReferenceEnumeration

part of: Student_Recruiting_CampaignObjectID
Base Type
string
top
 

Student_Recruiting_Event_LocationReferenceEnumeration

part of: Student_Recruiting_Event_LocationObjectID
Base Type
string
top
 

Student_Recruiting_Event_TypeReferenceEnumeration

part of: Student_Recruiting_Event_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Academic_ContactReferenceEnumeration

part of: Academic_ContactObjectID
Base Type
string
top
 

Date_IntervalReferenceEnumeration

part of: Date_IntervalObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Communication_Usage_TypeReferenceEnumeration

part of: Communication_Usage_TypeObjectID
Base Type
string
top
 

Student_Engagement_ItemReferenceEnumeration

part of: Student_Engagement_ItemObjectID
Base Type
string
top
 

Student_Recruiting_Event_Send_ToReferenceEnumeration

part of: Student_Recruiting_Event_Send_ToObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Dynamic_Engagement_Plan_Population__Student_ReferenceEnumeration

part of: Dynamic_Engagement_Plan_Population__Student_ObjectID
Base Type
string
top