Service Directory > v32.1 > Student_Recruiting > Get_Student_Recruiting_Campaigns
 

Operation: Get_Student_Recruiting_Campaigns

Retrieves Student Recruiting Campaigns by reference, or returns all Campaigns if no reference 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_Student_Recruiting_Campaigns_Request

Get Request for Student Recruiting Campaigns
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Recruiting_Campaign_Request_References  [0..1]  Contains Request References for Student Recruiting Campaigns   
Request_Criteria [Choice]   Student_Recruiting_Campaign_Request_Criteria  [0..1]  Contains request criteria to get specific Student Recruiting Campaigns   
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_Student_Recruiting_Campaigns_Response

Get Response for a Student Recruiting Campaign
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Recruiting_Campaign_Request_References  [0..1]  Contains Request References for a Student Recruiting Campaign   
Request_Criteria  Student_Recruiting_Campaign_Request_Criteria  [0..1]  Contains request criteria data for Student Recruiting Campaigns   
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  Student_Recruiting_Campaign_Response_Data  [0..1]  Contains Student Recruiting Campaign Response Data   
top
 

Student_Recruiting_Campaign_Request_References

part of: Get_Student_Recruiting_Campaigns_Request, Get_Student_Recruiting_Campaigns_Response
Contains Request References for Student Recruiting Campaigns
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Campaign_Reference  Student_Recruiting_CampaignObject  [1..*]  Specifies Student Recruiting Campaign Request References   
top
 

Student_Recruiting_CampaignObject

part of: Student_Recruiting_Campaign_Request_References, Student_Recruiting_Campaign
 
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_Campaign_Request_Criteria

part of: Get_Student_Recruiting_Campaigns_Request, Get_Student_Recruiting_Campaigns_Response
Contains request criteria to get specific Student Recruiting Campaigns
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Campaign_Name  string  [0..1]  Specifies a name for Student Recruiting Campaign Request Criteria   
top
 

Response_Filter

part of: Get_Student_Recruiting_Campaigns_Request, Get_Student_Recruiting_Campaigns_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_Campaigns_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_Campaign_Response_Data

part of: Get_Student_Recruiting_Campaigns_Response
Contains Student Recruiting Campaign Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Campaign  Student_Recruiting_Campaign  [0..*]  Contains Student Recruiting Campaign Response Data   
top
 

Student_Recruiting_Campaign

part of: Student_Recruiting_Campaign_Response_Data
Contains Student Recruiting Campaign Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Campaign_Reference  Student_Recruiting_CampaignObject  [0..1]  References a Student Recruiting Campaign   
Student_Recruiting_Campaign_Data  Student_Recruiting_Campaign_Data  [0..1]  Contains Student Recruiting Campaign Data 
Validation Description
The End Date must be on or after the Start Date   
Engagement Plans on Recruiting Campaigns must have the Student Recruiting Engagement Category.   
The selected Engagement Plan must have the same Academic Unit and Level as the selected Recruiting Cycle   
 
top
 

Student_Recruiting_Campaign_Data

part of: Student_Recruiting_Campaign
Contains Student Recruiting Campaign Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Recruiting Campaign   
Name  string  [1..1]  References the name for a Student Recruiting Campaign   
Student_Recruiting_Cycle_Reference  Student_Recruiting_CycleObject  [1..1]  References a Student Recruiting Cycle for a Student Recruiting Campaign   
Owner_Reference  Admissions_CounselorObject  [1..1]  References an Owner for a Student Recruiting Campaign 
Validation Description
The Student Recruiter's End Date must be after the Campaign's Start Date.  The Student Recruiter's End Date must be after the Campaign's Start Date. 
The Student Recruiting Campaign Date Range is not within the assigned Recruiter's date range.  The Student Recruiting Campaign Date Range is not within the assigned Recruiter's date range. 
 
Engagement_Plan_Reference  Student_Engagement_PlanObject  [0..1]  References an Engagement Plan for a Student Recruiting Campaign   
Campaign_Type_Reference  Unique_IdentifierObject  [1..*]  References the Campaign Type for a Student Recruiting Campaign   
Start_Date  date  [1..1]  Specifies a Start Date for a Student Recruiting Campaign   
End_Date  date  [0..1]  Specifies an End Date for a Student Recruiting Campaign   
Region_Reference  RegionObject  [0..*]  References a Recruiting Region for a Student Recruiting Campaign   
Recruitment_Goal  decimal (12, 0) >0   [0..1]  Specifies a Goal for a Student Recruiting Campaign   
Budget  decimal (14, 2) >0   [0..1]  Specifies a Budget for a Student Recruiting Campaign   
Currency_Reference  CurrencyObject  [1..1]  References a Currency for a Student Recruiting Campaign   
Description  RichText  [0..1]  Specifies a description for a Student Recruiting Campaign   
Validation Description
The End Date must be on or after the Start Date   
Engagement Plans on Recruiting Campaigns must have the Student Recruiting Engagement Category.   
The selected Engagement Plan must have the same Academic Unit and Level as the selected Recruiting Cycle   
top
 

Student_Recruiting_CycleObject

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

Student_Recruiting_CycleObjectID

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

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

Student_Engagement_PlanObjectID

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

Unique_IdentifierObject

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

RegionObject

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

CurrencyObject

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

Student_Recruiting_CampaignReferenceEnumeration

part of: Student_Recruiting_CampaignObjectID
Base Type
string
top
 

Student_Recruiting_CycleReferenceEnumeration

part of: Student_Recruiting_CycleObjectID
Base Type
string
top
 

Admissions_CounselorReferenceEnumeration

part of: Admissions_CounselorObjectID
Base Type
string
top
 

Student_Engagement_PlanReferenceEnumeration

part of: Student_Engagement_PlanObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

RegionReferenceEnumeration

part of: RegionObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

RichText

part of: Student_Recruiting_Campaign_Data
Base Type
string
top