Service Directory > v32.1 > Campus_Engagement > Get_Student_Audiences
 

Operation: Get_Student_Audiences

Returns information for Student Audiences specified in the request. If the request does not specify a Student Audience, this operation returns information for all Student Audiences.


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

Get Student Audiences Request element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Audience_Request_References  [0..1]  Element containing reference instances for a Student Audience.   
Request_Criteria [Choice]   Student_Audience_Request_Criteria  [0..1]  Element used to request Student Audiences with specific criteria   
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_Group  Student_Audience_Response_Group  [0..1]  Element for Student Audience Response Group data.   
top
 

Response Element: Get_Student_Audiences_Response

Documentation Get Student Audiences Response element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Audience_Request_References  [0..1]  Element containing reference instances for a Student Audience.   
Request_Criteria  Student_Audience_Request_Criteria  [0..1]  Element used to request Student Audiences with specific criteria   
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_Group  Student_Audience_Response_Group  [0..1]  Element for Student Audience Response Group data.   
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  Student_Audience_Response_Data  [0..1]  Wrapper element that contains the Student Audience data elements that are included in the response   
top
 

Student_Audience_Request_References

part of: Get_Student_Audiences_Request, Get_Student_Audiences_Response
Element containing reference instances for a Student Audience.
 
Parameter name Type/Value Cardinality Description Validations
Student_Audience_Reference  Dynamic_Engagement_Plan_Population__Student_Object  [1..*]  Student Audience Reference   
top
 

Dynamic_Engagement_Plan_Population__Student_Object

part of: Student_Audience_Request_References
 
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_Audience_Request_Criteria

part of: Get_Student_Audiences_Request, Get_Student_Audiences_Response
Element used to request Student Audiences with specific criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Audiences_Request, Get_Student_Audiences_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
 

Student_Audience_Response_Group

part of: Get_Student_Audiences_Request, Get_Student_Audiences_Response
Element for Student Audience Response Group data.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Response Group used to control whether the Student Audience Reference is included in the Response.   
top
 

Response_Results

part of: Get_Student_Audiences_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_Audience_Response_Data

part of: Get_Student_Audiences_Response
Wrapper element that contains the Student Audience data elements that are included in the response
 
Parameter name Type/Value Cardinality Description Validations
Student_Audience  Student_Audience  [0..*]  This element is the wrapper element for all Student Audience data   
top
 

Student_Audience

part of: Student_Audience_Response_Data
Wrapper Element for a Student Audience
 
Parameter name Type/Value Cardinality Description Validations
Student_Audience_Reference  Dynamic_Connect_AudienceObject  [0..1]  Student Audience Reference   
Student_Audience_Data  Student_Audience_Data  [0..1]  Contains all References and Attributes for a Student Audience 
Validation Description
Admissions Engagement Criteria can only be used with the Admissions engagement category.   
Recruiting Engagement Criteria can only be used with the Student Recruiting engagement category.   
The Custom Report used is invalid for Student Audiences with the selected Engagement Category.   
Run As User must either be an Active Worker or an Active Admissions Counselor.   
The Saved Search used is invalid for Student Audiences with the selected Engagement Category.   
The Run As User does not have access to the Report Definition for the Custom Report or Saved Search   
 
top
 

Dynamic_Connect_AudienceObject

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

Dynamic_Connect_AudienceObjectID

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

part of: Student_Audience
Contains all References and Attributes for a Student Audience
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Student Audience Reference ID can be used to uniquely identify a Student Audience   
Name  string  [1..1]  Name of the Student Audience   
Description  RichText  [0..1]  Description of the Student Audience   
Category_Reference  Engagement_CategoryObject  [1..1]  Engagement Category for the Student Audience 
Validation Description
Engagement Category cannot be edited   
 
Used_For_Reference  Engagement_Category_UsageObject  [1..1]  Engagement Category Usage for the Student Audience. 
Validation Description
Student Audience Category Usage cannot be edited   
 
Academic_Unit_Subedit_Data  Academic_Curricular_Division_Subedit_Level_Optional_Data  [1..1]  Contains Academic Unit information for a Student Prospect where the Academic Level is optional 
Validation Description
Academic Level cannot be edited   
Academic Unit cannot be edited   
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Custom_Report_Reference [Choice]   Custom_Report_DefinitionObject  [1..1]  Custom Report reference for the Student Audience.   
Saved_Search_Reference [Choice]   Unique_IdentifierObject  [1..1]  Saved Search Reference for the Student Audience.   
Recruiting_Engagement_Criteria_Data [Choice]   Recruiting_Engagement_Criteria_Data  [1..1]  Student Audience Recruiting Engagement Criteria Data 
Validation Description
Select a Prospect Stage other than Student.   
Only Academic Periods containing a usage of Academic can be used.   
 
Admissions_Engagement_Criteria_Data [Choice]   Admissions_Engagement_Criteria_Data  [1..1]  Student Audience Admissions Engagement Criteria Data 
Validation Description
Admissions Engagement Plans can't use the Student Prospect Stages of Inquirer, Lead, or Pre-Applicant.   
Only Academic Periods containing a usage of Academic can be used.   
Student Prospect Stage is required on internal element 'Admissions Engagement Criteria Data'.   
Academic Level is required.   
 
Run_As_User_Reference  RoleObject  [1..1]  Run As User reference for the Student Audience.   
Inactive  boolean  [0..1]  Inactive attribute for the Student Audience.   
Validation Description
Admissions Engagement Criteria can only be used with the Admissions engagement category.   
Recruiting Engagement Criteria can only be used with the Student Recruiting engagement category.   
The Custom Report used is invalid for Student Audiences with the selected Engagement Category.   
Run As User must either be an Active Worker or an Active Admissions Counselor.   
The Saved Search used is invalid for Student Audiences with the selected Engagement Category.   
The Run As User does not have access to the Report Definition for the Custom Report or Saved Search   
top
 

Engagement_CategoryObject

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

Engagement_CategoryObjectID

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

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

Engagement_Category_UsageObjectID

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

part of: Student_Audience_Data
Contains Academic Unit information for a Student Prospect where the Academic Level is optional
 
Parameter name Type/Value Cardinality Description Validations
Academic_Level_Reference  Academic_LevelObject  [0..1]  References an Academic Level for a Student Prospect   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit Reference 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_LevelObject

part of: Academic_Curricular_Division_Subedit_Level_Optional_Data, Recruiting_Engagement_Criteria_Data, Admissions_Engagement_Criteria_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_Curricular_DivisionObject

part of: Academic_Curricular_Division_Subedit_Level_Optional_Data, Recruiting_Engagement_Criteria_Data, Admissions_Engagement_Criteria_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_Curricular_DivisionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_Curricular_DivisionObjectID

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

Custom_Report_DefinitionObject

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

Custom_Report_DefinitionObjectID

part of: Custom_Report_DefinitionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Report_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [1..1]  The unique identifier type of a parent object   
top
 

Unique_IdentifierObject

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

Recruiting_Engagement_Criteria_Data

part of: Student_Audience_Data
Engagement Plan Student Recruiting Engagement Criteria
 
Parameter name Type/Value Cardinality Description Validations
Stage_Reference  Student_Prospect_StageObject  [1..*]  Student Prospect Stage for Engagement Plan or Student Audience   
Student_Tag_Reference  Student_TagObject  [0..*]  Student Tag   
Educational_Institution_Reference  Educational_InstitutionObject  [0..*]  Educational Institution for Engagement Plan or Student Audience   
Educational_Interest_Reference  Educational_InterestObject  [0..*]  Educational Interest for Engagement Plan or Student Audience   
Anticipated_Start_Date_Begin  date  [0..1]  Anticipated Start Date Begin for Engagement Plan or Student Audience   
Anticipated_Start_Date_End  date  [0..1]  Anticipated Start Date End for Engagement Plan or Student Audience 
Validation Description
Enter a Latest Anticipated Start Date that is on or after the Earliest Anticipated Start Date.   
 
Anticipated_Start_Period_Reference  Academic_PeriodObject  [0..*]  Academic Period for Engagement Plan or Student Audience   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..*]  Academic Unit for Engagement Plan or Student Audience 
Validation Description
The Academic Unit entered is not configured for Recruiting on any of its levels   
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [1..*]  Academic Level   
Region_Reference  RegionObject  [0..*]  Recruiting Region for Engagement Plan or Student Audience   
Admissions_Eligibility_Rule_Reference  Student_Eligibility_RuleObject  [0..1]  Eligibility Rule for Engagement Plan or Student Audience   
Validation Description
Select a Prospect Stage other than Student.   
Only Academic Periods containing a usage of Academic can be used.   
top
 

Student_Prospect_StageObject

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

Student_Prospect_StageObjectID

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

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

Student_TagObjectID

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

Educational_InstitutionObject

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

Educational_InstitutionObjectID

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

Educational_InterestObject

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

Educational_InterestObjectID

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

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

Academic_PeriodObjectID

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

RegionObject

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

RegionObjectID

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

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

Student_Eligibility_RuleObjectID

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

part of: Student_Audience_Data
Engagement Plan Admissions Engagement Criteria
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..*]  Academic Unit 
Validation Description
The Academic Unit entered is not configured for Admissions on any of its levels.   
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level for Engagement Plan or Student Audience   
Student_Prospect_Stage_Reference  Student_Prospect_StageObject  [0..*]  Student Prospect Stage for Engagement Plan or Student Audience   
Student_Tag_Reference  Student_TagObject  [0..*]  Student Tag for Engagement Plan or Student Audience   
Program_of_Study_Reference  Program_of_StudyObject  [0..*]  Program of Study for Engagement Plan or Student Audience 
Validation Description
The Program of Study is not Approved.   
 
Applicant_Type_Reference  Student_Applicant_TypeObject  [0..*]  Applicant Type for Engagement Plan or Student Audience   
Application_Requirement_Status_Reference  Student_Application_Requirement_StatusObject  [0..*]  Application File Status for Engagement Plan or Student Audience   
Admission_Decision_Reference  Admission_DecisionObject  [0..*]  Admission Decision for Engagement Plan or Student Audience   
Admission_Response_Reference  Student_Application_Admission_ResponseObject  [0..*]  Admission Response for Engagement Plan or Student Audience   
Admissions_Eligibility_Rule_Reference  Student_Eligibility_RuleObject  [0..1]  Eligibility Rule for Engagement Plan or Student Audience   
Anticipated_Start_Date_Begin  date  [0..1]  Anticipated Start Date Begin for Engagement Plan or Student Audience   
Anticipated_Start_Date_End  date  [0..1]  Anticipated Start Date End for Engagement Plan or Student Audience   
Anticipated_Start_Period_Reference  Academic_PeriodObject  [0..*]  Academic Period for Engagement Plan or Student Audience   
Validation Description
Admissions Engagement Plans can't use the Student Prospect Stages of Inquirer, Lead, or Pre-Applicant.   
Only Academic Periods containing a usage of Academic can be used.   
Student Prospect Stage is required on internal element 'Admissions Engagement Criteria Data'.   
Academic Level is required.   
top
 

Program_of_StudyObject

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

Program_of_StudyObjectID

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

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

Student_Applicant_TypeObjectID

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

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

Student_Application_Requirement_StatusObjectID

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

Admission_DecisionObject

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

Admission_DecisionObjectID

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

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

Student_Application_Admission_ResponseObjectID

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

RoleObject

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

RoleObjectID

part of: RoleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Contact_ID, Academic_Person_ID, Applicant_ID, Beneficiary_ID, Business_Entity_Contact_ID, Candidate_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Dependent_ID, Emergency_Contact_ID, Employee_ID, Extended_Enterprise_Contact_Person_ID, Extended_Enterprise_Learner_ID, External_Committee_Member_ID, Former_Worker_ID, Instructor_ID, Learning_Assessor_ID, Learning_Instructor_ID, LearningUserName, Organization_Reference_ID, Recruiting_Agency_User_ID, RecruitingUserName, Region_Reference_ID, Service_Center_Representative_ID, Student_ID, Student_Proxy_ID, Student_Recruiter_ID, StudentUserName, SupplierUserName, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [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_ReferenceEnumeration

part of: Dynamic_Engagement_Plan_Population__Student_ObjectID
Base Type
string
top
 

Dynamic_Connect_AudienceReferenceEnumeration

part of: Dynamic_Connect_AudienceObjectID
Base Type
string
top
 

RichText

part of: Student_Audience_Data
Base Type
string
top
 

Engagement_CategoryReferenceEnumeration

part of: Engagement_CategoryObjectID
Base Type
string
top
 

Engagement_Category_UsageReferenceEnumeration

part of: Engagement_Category_UsageObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Custom_Report_DefinitionReferenceEnumeration

part of: Custom_Report_DefinitionObjectID
Base Type
string
top
 

Base Type
string

top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Student_Prospect_StageReferenceEnumeration

part of: Student_Prospect_StageObjectID
Base Type
string
top
 

Student_TagReferenceEnumeration

part of: Student_TagObjectID
Base Type
string
top
 

Educational_InstitutionReferenceEnumeration

part of: Educational_InstitutionObjectID
Base Type
string
top
 

Educational_InterestReferenceEnumeration

part of: Educational_InterestObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

RegionReferenceEnumeration

part of: RegionObjectID
Base Type
string
top
 

Student_Eligibility_RuleReferenceEnumeration

part of: Student_Eligibility_RuleObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

Student_Applicant_TypeReferenceEnumeration

part of: Student_Applicant_TypeObjectID
Base Type
string
top
 

Student_Application_Requirement_StatusReferenceEnumeration

part of: Student_Application_Requirement_StatusObjectID
Base Type
string
top
 

Admission_DecisionReferenceEnumeration

part of: Admission_DecisionObjectID
Base Type
string
top
 

Student_Application_Admission_ResponseReferenceEnumeration

part of: Student_Application_Admission_ResponseObjectID
Base Type
string
top
 

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top