Service Directory > v31.2 > Student_Recruiting > Get_Student_Recruiting_Rating_Scales
 

Operation: Get_Student_Recruiting_Rating_Scales

Returns Student Recruiting Rating Scales by Reference ID, or returns all Student Recruiting Rating Scales 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_Rating_Scales_Request

Element Container for Get Student Recruiting Rating Scales Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Recruiting_Rating_Scale_Request_References  [0..1]  Element Container for Student Recruiting Rating Scale Request References.   
Response_Filter  Response_Filter  [0..1]  Element Container for Student Recruiting Rating Scales Request Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Recruiting_Rating_Scales_Response

Element Container for Get Student Recruiting Rating Scales Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Recruiting_Rating_Scale_Request_References  [0..1]  Element Container for Student Recruiting Rating Scale Request References.   
Response_Filter  Response_Filter  [0..1]  Element Container for Student Recruiting Rating Scales Request Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element Container for Student Recruiting Rating Scale Response Results.   
Response_Data  Student_Recruiting_Rating_Scale_Response_Data  [0..1]  Element Container for Student Recruiting Rating Scale Response Data.   
top
 

Student_Recruiting_Rating_Scale_Request_References

part of: Get_Student_Recruiting_Rating_Scales_Request, Get_Student_Recruiting_Rating_Scales_Response
Element Container for Student Recruiting Rating Scale Request References.
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Rating_Scale_Reference  Student_Recruiting_Rating_ScaleObject  [1..*]  Element Container for Student Recruiting Rating Scale Reference.   
top
 

Student_Recruiting_Rating_ScaleObject

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

Student_Recruiting_Rating_ScaleObjectID

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

part of: Get_Student_Recruiting_Rating_Scales_Response
Element Container for Student Recruiting Rating Scale Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Rating_Scale  Student_Recruiting_Rating_Scale  [0..*]  Element Container for Student Recruiting Rating Scale.   
top
 

Student_Recruiting_Rating_Scale

part of: Student_Recruiting_Rating_Scale_Response_Data
Element Container for Student Recruiting Rating Scale.
 
Parameter name Type/Value Cardinality Description Validations
Student_Recruiting_Rating_Scale_Reference  Student_Recruiting_Rating_ScaleObject  [0..1]  Element Container for Student Recruiting Rating Scale Reference.   
Student_Recruiting_Rating_Scale_Data  Student_Recruiting_Rating_Scale_Data  [0..*]  Element Container for Student Recruiting Rating Scale Data. 
Validation Description
Enter a Student Recruiting Rating Scale Name that isn't already in use.   
You can't edit the Academic Unit and Level of Rating Scales if any of the Ratings are in use.   
You can't delete Student Recruiting Ratings that are in use.   
 
top
 

Student_Recruiting_Rating_Scale_Data

part of: Student_Recruiting_Rating_Scale
Element Container for Student Recruiting Rating Scale Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The reference ID for the Student Recruiting Rating Scale.   
Student_Recruiting_Rating_Scale_Name  string  [1..1]  The name for the Student Recruiting Rating Scale.   
Student_Recruiting_Rating_Scale_Description  RichText  [0..1]  The description for the Student Recruiting Rating Scale.   
Academic_Unit_Data  Has_Academic_Unit_with_Shareable_Subordinates_Data  [1..1]  Academic Unit Data 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Student_Recruiting_Rating_Data  Student_Recruiting_Rating_Subedit_Data  [1..*]  Element Container for Student Recruiting Rating Data.   
Validation Description
Enter a Student Recruiting Rating Scale Name that isn't already in use.   
You can't edit the Academic Unit and Level of Rating Scales if any of the Ratings are in use.   
You can't delete Student Recruiting Ratings that are in use.   
top
 

Has_Academic_Unit_with_Shareable_Subordinates_Data

part of: Student_Recruiting_Rating_Scale_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_Rating_Subedit_Data

part of: Student_Recruiting_Rating_Scale_Data
Element Container for Student Recruiting Rating Subedit Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The reference ID for the Student Recruiting Rating.   
Student_Recruiting_Rating_Order  string  [1..1]  The alphanumeric order in which the Student Recruiting Rating is displayed relative to any other Student Recruiting Ratings associated with a given Student Recruiting Rating Scale.   
Student_Recruiting_Rating_Value  string  [1..1]  The value for the Student Recruiting Rating.   
Student_Recruiting_Rating_Score  decimal (11, 2) >0   [0..1]  The score for the Student Recruiting Rating.   
top
 

Student_Recruiting_Rating_ScaleReferenceEnumeration

part of: Student_Recruiting_Rating_ScaleObjectID
Base Type
string
top
 

RichText

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