Service Directory > v32.1 > Student_Recruiting > Get_Student_Recruiting_Cycles
 

Operation: Get_Student_Recruiting_Cycles

Returns information for Student Recruiting Cycles specified in the request. If the request does not specify a Student Recruiting Cycle, this operation returns information for all Student Recruiting Cycles.


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

Wrapper element for Student Recruiting Cycle Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Recruiting_Cycle_Request_References  [0..1]  Element containing the list of Student Recruiting Cycle(s) for which data is requested.   
Request_Criteria [Choice]   Student_Recruiting_Cycle_Request_Criteria  [0..1]  Element to specify criteria options to search for Student Recruiting Cycles within the Workday system. Search by Name, Academic Period, and/or Academic Unit.   
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_Cycles_Response

Wrapper element for the Student Recruiting Cycle Information returned as a result of a Get Student Recruiting Cycle request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Recruiting_Cycle_Request_References  [0..1]  Element containing the list of Student Recruiting Cycles for which data is requested.   
Request_Criteria  Student_Recruiting_Cycle_Request_Criteria  [0..1]  Utilize the following criteria options to search for Student Recruiting Cycles within the Workday system. The Student Recruiting Cycle references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criterium that is populated.   
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_Cycle_Response_Data  [0..1]  Wrapper element for the Student Recruiting Cycle data   
top
 

Student_Recruiting_Cycle_Request_References

part of: Get_Student_Recruiting_Cycles_Request, Get_Student_Recruiting_Cycles_Response
Element containing the list of Student Recruiting Cycles for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Cycle_Reference  Student_Recruiting_CycleObject  [1..*]  Workset of Student Recruiting Cycles for which data is requested.   
top
 

Student_Recruiting_CycleObject

part of: Student_Recruiting_Cycle_Request_References, Student_Recruiting_Cycle
 
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
 

Student_Recruiting_Cycle_Request_Criteria

part of: Get_Student_Recruiting_Cycles_Request, Get_Student_Recruiting_Cycles_Response
Utilize the following criteria options to search for Student Recruiting Cycles within the Workday system. The Student Recruiting Cycle references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criterium that is populated.
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Cycle_Name  string  [0..1]  Search for a Student Recruiting Cycle using the Name. The match could be an exact match or a partial match with a Student Recruiting Cycle Name that contains the Name specified.   
top
 

Response_Filter

part of: Get_Student_Recruiting_Cycles_Request, Get_Student_Recruiting_Cycles_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_Cycles_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_Cycle_Response_Data

part of: Get_Student_Recruiting_Cycles_Response
Wrapper element for the Student Recruiting Cycle data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Cycle  Student_Recruiting_Cycle  [0..*]  Wrapper element for the Student Recruiting Cycle data.   
top
 

Student_Recruiting_Cycle

part of: Student_Recruiting_Cycle_Response_Data
Wrapper element for the Student Recruiting Cycle data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Cycle_Reference  Student_Recruiting_CycleObject  [0..1]  Reference ID for the Student Recruiting Cycle.   
Student_Recruiting_Cycle_Data  Student_Recruiting_Cycle_Data  [0..1]  Wrapper element for the Student Recruiting Cycle data.   
top
 

Student_Recruiting_Cycle_Data

part of: Student_Recruiting_Cycle
Wrapper element for the Student Recruiting Cycle data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Recruiting Cycle Data   
Name  string  [1..1]  Student Recruiting Cycle Name. 
Validation Description
Enter a Name that isn't already in use.   
 
Academic_Unit_Subedit_Data  Has_Academic_Curricular_Division_Data  [1..*]  Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level 
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
 
Academic_Date_Range_Reference  Academic_Date_RangeObject  [1..1]  References the academic date range for a cycle   
Description  RichText  [0..1]  References a Description for a Student Recruiting Cycle   
top
 

Has_Academic_Curricular_Division_Data

part of: Student_Recruiting_Cycle_Data
Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level Nonsingular Workset   
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_Curricular_DivisionObject

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

Academic_LevelObject

part of: Has_Academic_Curricular_Division_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_Date_RangeObject

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

Academic_Date_RangeObjectID

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

part of: Student_Recruiting_CycleObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_Date_RangeReferenceEnumeration

part of: Academic_Date_RangeObjectID
Base Type
string
top
 

RichText

part of: Student_Recruiting_Cycle_Data
Base Type
string
top