Service Directory > v32.1 > Student_Recruiting > Put_Student_Prospect_Stage_Progression_Rule
 

Operation: Put_Student_Prospect_Stage_Progression_Rule

Creates or Updates an Admission Stage Progression Rule 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: Put_Student_Prospect_Stage_Progression_Rule_Request

Web Service Request Element for Add/Edit a Admission Stage Progression Rule
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Flag to indicate this request may only be used to add a new rule, not modify an existing one.   
@Delete  boolean  [1..1]  Flag to indicate this request may only be used to delete an old rule, not create or edit another rule.   
Student_Prospect_Stage_Progression_Rule_Reference  Student_Prospect_Stage_Progression_RuleObject  [0..1]  Element containing Reference ID of the rule to modify (not present when adding new rules).   
Student_Prospect_Stage_Progression_Rule_Data  Student_Prospect_Stage_Progression_Rule_Data  [0..1]  Web Service element for Admission Stage Progression Rule data 
Validation Description
Student Prospect Stage Progression Rules may use only the following stages: Lead, Prospect, Pre-Applicant.   
You must select a unique combination of Academic Unit, Academic Level, Student Prospect Stage Progression Action, New Prospect Stage, and Current Prospect Stage.   
The Academic Unit entered is not configured for Recruiting on any of its levels   
Select a Current Stage that is not already in use by the Update Action.   
Please specify different stages for the Current Stage and New Stage fields.   
 
Validation Description
The Web Service is set to Add Only, but the Student Prospect Stage Progression Rule already exists.   
The Web Service can not be set to both Add Only and Delete.   
The Web Service is set to Delete, but the Student Prospect Stage Progression Rule does not already exist.   
The Student Prospect Stage Progression Rule Data element is required for non-deletion operations.   
top
 

Response Element: Put_Student_Prospect_Stage_Progression_Rule_Response

Web Service Element containing the Reference ID of the New/Modified Admission Stage Progression Rule
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Prospect_Stage_Progression_Rule_Reference  Student_Prospect_Stage_Progression_RuleObject  [0..1]  The Reference ID of the New/Modifed Admission Stage Progression Rule   
top
 

Student_Prospect_Stage_Progression_RuleObject

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

Student_Prospect_Stage_Progression_RuleObjectID

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

Student_Prospect_Stage_Progression_Rule_Data

part of: Put_Student_Prospect_Stage_Progression_Rule_Request
Web Service element for Admission Stage Progression Rule data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Admission Stage Progression Rule   
Academic_Unit_Subedit_Data  Academic_Curricular_Division_Subedit_Data  [0..*]  Contains Academic Unit information for a Student Prospect 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Student_Prospect_Stage_Progression_Action_Reference  Student_Prospect_Stage_Progression_ActionObject  [1..1]  Admission Stage Progression Action reference for Admission Stage Progression Rule   
Current_Stage_Reference  Student_Prospect_StageObject  [1..1]  Current Prospect Stage reference for Admission Stage Progression Rule   
New_Stage_Reference  Student_Prospect_StageObject  [1..1]  New Prospect Stage reference for Admission Stage Progression Rule   
Validation Description
Student Prospect Stage Progression Rules may use only the following stages: Lead, Prospect, Pre-Applicant.   
You must select a unique combination of Academic Unit, Academic Level, Student Prospect Stage Progression Action, New Prospect Stage, and Current Prospect Stage.   
The Academic Unit entered is not configured for Recruiting on any of its levels   
Select a Current Stage that is not already in use by the Update Action.   
Please specify different stages for the Current Stage and New Stage fields.   
top
 

Academic_Curricular_Division_Subedit_Data

part of: Student_Prospect_Stage_Progression_Rule_Data
Contains Academic Unit information for a Student Prospect
 
Parameter name Type/Value Cardinality Description Validations
Academic_Level_Reference  Academic_LevelObject  [1..1]  References an Academic Level for a Student Prospect   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  References an Academic Unit for a Student Prospect 
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_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_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
 

Student_Prospect_Stage_Progression_ActionObject

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

Student_Prospect_Stage_Progression_ActionObjectID

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

part of: Student_Prospect_Stage_Progression_Rule_Data, Student_Prospect_Stage_Progression_Rule_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_Prospect_Stage_Progression_RuleReferenceEnumeration

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

Student_Prospect_Stage_Progression_ActionReferenceEnumeration

part of: Student_Prospect_Stage_Progression_ActionObjectID
Base Type
string
top
 

Student_Prospect_StageReferenceEnumeration

part of: Student_Prospect_StageObjectID
Base Type
string
top