Service Directory > v31.2 > Student_Recruiting > Submit_Student_Recruiting_Campaign
 

Operation: Submit_Student_Recruiting_Campaign

Creates a new Student Recruiting Campaign (or updates an existing Student Recruiting Campaign) using the information provided in the request.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Submit_Student_Recruiting_Campaign_Request

Put Request for a Student Recruiting Campaign
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Student_Recruiting_Campaign_Reference  Student_Recruiting_CampaignObject  [0..1]  References a Student Recruiting Campaign   
Student_Business_Process_Parameters  Student_Business_Process_Parameters  [0..1]  Contains Business Process parameters such as "Autocomplete" and comment fields   
Student_Recruiting_Campaign_Data  Student_Recruiting_Campaign_Data  [1..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   
 
Validation Description
The Web Service is set to Add Only, but the Student Recruiting Campaign already exists.   
top
 

Response Element: Submit_Student_Recruiting_Campaign_Response

Put Response for Student Recruiting Campaigns
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Recruiting_Campaign_Reference  Student_Recruiting_CampaignObject  [0..1]  References a Student Recruiting Campaign   
top
 

Student_Recruiting_CampaignObject

part of: Submit_Student_Recruiting_Campaign_Request, Submit_Student_Recruiting_Campaign_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  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_Business_Process_Parameters

part of: Submit_Student_Recruiting_Campaign_Request
Contains Business Process parameters such as "Autocomplete" and comment fields
 
Parameter name Type/Value Cardinality Description Validations
Automatically_Complete  boolean  [0..1]  Flag to automatically complete the Student Recruiting Campaign Business Process   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Student_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

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

WorkerReferenceEnumeration

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