Service Directory > v31.2 > Student_Recruiting > Get_Student_Prospect_Stage_Progression_Rules
 

Operation: Get_Student_Prospect_Stage_Progression_Rules

Retrieves an Student Prospect Stage Progression Rule by Name or reference, or returns all Student Prospect Stage Progression Rules 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_Prospect_Stage_Progression_Rules_Request

Web Service Element for Get Admission Stage Progression Rules Requests
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Prospect_Stage_Progression_Rule_Request_References  [0..1]  Web Service Element containing the list of Admission Stage Progression Rules for which data is requested.   
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_Prospect_Stage_Progression_Rules_Response

The Web Service Element containing a Get Admission Stage Progression Rule Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Prospect_Stage_Progression_Rule_Request_References  [0..1]  Web Service Element containing the list of Admission Stage Progression Rules for which data is requested.   
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_Prospect_Stage_Progression_Rule_Response_Data  [0..1]  The Web Service Element containing data for a Get Admission Stage Progression Rule Response   
top
 

Student_Prospect_Stage_Progression_Rule_Request_References

part of: Get_Student_Prospect_Stage_Progression_Rules_Request, Get_Student_Prospect_Stage_Progression_Rules_Response
Web Service Element containing the list of Admission Stage Progression Rules for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Student_Prospect_Stage_Progression_Rule_Reference  Student_Prospect_Stage_Progression_RuleObject  [1..*]  The Admission Stage Progression Rule(s) for which data is requested.   
top
 

Student_Prospect_Stage_Progression_RuleObject

part of: Student_Prospect_Stage_Progression_Rule_Request_References, Student_Prospect_Stage_Progression_Rule
 
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
 

Response_Filter

part of: Get_Student_Prospect_Stage_Progression_Rules_Request, Get_Student_Prospect_Stage_Progression_Rules_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_Prospect_Stage_Progression_Rules_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_Prospect_Stage_Progression_Rule_Response_Data

part of: Get_Student_Prospect_Stage_Progression_Rules_Response
The Web Service Element containing data for a Get Admission Stage Progression Rule Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Prospect_Stage_Progression_Rule  Student_Prospect_Stage_Progression_Rule  [0..*]  Web Service element containing Reference ID and data for Admission Stage Progression Rule   
top
 

Student_Prospect_Stage_Progression_Rule

part of: Student_Prospect_Stage_Progression_Rule_Response_Data
Web Service element containing Reference ID and data for Admission Stage Progression Rule
 
Parameter name Type/Value Cardinality Description Validations
Student_Prospect_Stage_Progression_Rule_Reference  Student_Prospect_Stage_Progression_RuleObject  [0..1]  The Admission Stage Progression Rule reference   
Student_Prospect_Stage_Progression_Rule_Data  Student_Prospect_Stage_Progression_Rule_Data  [0..*]  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.   
 
top
 

Student_Prospect_Stage_Progression_Rule_Data

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