Service Directory > v31.2 > Student_Recruiting > Get_Student_Recruiting_Referral_Sources
 

Operation: Get_Student_Recruiting_Referral_Sources

Returns Student Recruiting Referral sources by Reference ID, or returns all Student Recruiting Referral Sources if no Reference ID is provided.


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

Container for Get Student Recruiting Referral Sources Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Recruiting_Referral_Source_Request_References  [0..1]  Element Container for Student Recruiting Referral Source Request References   
Request_Criteria [Choice]   Student_Recruiting_Referral_Source_Request_Criteria  [0..1]  Element Container for Student Recruiting Referral Source Request Criteria   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Recruiting_Referral_Sources_Response

Container for Get Student Recruiting Referral Sources Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Recruiting_Referral_Source_Request_References  [0..1]  Element Container for Student Recruiting Referral Source Request References   
Request_Criteria  Student_Recruiting_Referral_Source_Request_Criteria  [0..1]  Element Container for Student Recruiting Referral Source Request Criteria   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element Container for Response Results   
Response_Data  Student_Recruiting_Referral_Source_Response_Data  [0..1]  Element Container for Student Recruiting Referral Source Response Data   
top
 

Student_Recruiting_Referral_Source_Request_References

part of: Get_Student_Recruiting_Referral_Sources_Request, Get_Student_Recruiting_Referral_Sources_Response
Element contains the specific reference element(s) used to return Student Recruiting Referral Source(s) data
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Referral_Source_Reference  Student_Recruiting_Referral_SourceObject  [1..*]  Secured Workset for Student Recruiting Referral Source   
top
 

Student_Recruiting_Referral_SourceObject

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

Student_Recruiting_Referral_SourceObjectID

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

part of: Get_Student_Recruiting_Referral_Sources_Request, Get_Student_Recruiting_Referral_Sources_Response
Container for Student Recruiting Referral Source Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Recruiting_Referral_Sources_Request, Get_Student_Recruiting_Referral_Sources_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_Referral_Sources_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_Referral_Source_Response_Data

part of: Get_Student_Recruiting_Referral_Sources_Response
Container for Student Recruiting Referral Source Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Referral_Source  Student_Recruiting_Referral_Source  [0..*]  Element Container for Student Recruiting Referral Source   
top
 

Student_Recruiting_Referral_Source

part of: Student_Recruiting_Referral_Source_Response_Data
Container for Student Recruiting Referral Source
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Referral_Source_Reference  Student_Recruiting_Referral_SourceObject  [0..1]  Singular Secured Workset for Student Recruiting Referral Source   
Student_Recruiting_Referral_Source_Data  Student_Recruiting_Referral_Source_Data  [0..*]  Element Container for Student Recruiting Referral Source Data 
Validation Description
A Student Recruiting Referral Source with this name already exists.   
 
top
 

Student_Recruiting_Referral_Source_Data

part of: Student_Recruiting_Referral_Source
Container for Student Recruiting Referral Source
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Student Recruiting Referral Source Reference ID   
Name  string  [1..1]  Student Recruiting Referral Source Name   
Description  RichText  [0..1]  Student Recruiting Referral Source Description   
Academic_Unit_Data  Has_Academic_Unit_with_Shareable_Subordinates_Data  [1..1]  Element Container for Has Academic Unit with Shareable Subordinates Data 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Validation Description
A Student Recruiting Referral Source with this name already exists.   
top
 

Has_Academic_Unit_with_Shareable_Subordinates_Data

part of: Student_Recruiting_Referral_Source_Data
Academic Unit Data with Shareable with Subordinates Data
 
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 for Has Academic Unit with Shareable Subordinates Data element   
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_Curricular_DivisionObject

part of: Has_Academic_Unit_with_Shareable_Subordinates_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_Unit_with_Shareable_Subordinates_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
 

Student_Recruiting_Referral_SourceReferenceEnumeration

part of: Student_Recruiting_Referral_SourceObjectID
Base Type
string
top
 

RichText

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