Service Directory > v31.2 > Academic_Foundation > Get_Student_Grading_Schemes
 

Operation: Get_Student_Grading_Schemes

Returns Student Grading Scheme based on Name and Effective Date, or returns all instances of Student Grading Scheme if no criteria is specified. Only values that are effective as of the specified Effective Date will be returned.


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

Get Student Grading Schemes Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Grading_Scheme_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Student_Grading_Scheme_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Grading_Schemes_Response

Student Grading Scheme Response Warpper
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Grading_Scheme_Request_References  [0..1]  Student Grading Scheme Request References Wrapper Element   
Request_Criteria  Student_Grading_Scheme_Request_Criteria  [0..1]  Student Grading Scheme Request Criteria Wrapper Element   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Student_Grading_Scheme_Response_Data  [0..1]  Student Grading Scheme Response Data Wrapper Element   
top
 

Student_Grading_Scheme_Request_References

part of: Get_Student_Grading_Schemes_Request, Get_Student_Grading_Schemes_Response
Student Grading Scheme Request References Element
 
Parameter name Type/Value Cardinality Description Validations
Student_Grading_Scheme_Reference  Student_Grading_SchemeObject  [1..*]  Student Grading Scheme References   
top
 

Student_Grading_SchemeObject

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

Student_Grading_SchemeObjectID

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

part of: Get_Student_Grading_Schemes_Request, Get_Student_Grading_Schemes_Response
Student Grading Scheme Criteria Element
 
Parameter name Type/Value Cardinality Description Validations
Grading_Scheme_Name  string  [0..1]  Student Name to Filter on   
Effective_As_Of_Date  date  [0..1]  Effective As of Date   
top
 

Response_Filter

part of: Get_Student_Grading_Schemes_Request, Get_Student_Grading_Schemes_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_Grading_Schemes_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_Grading_Scheme_Response_Data

part of: Get_Student_Grading_Schemes_Response
Get Response for Student Grading Scheme
 
Parameter name Type/Value Cardinality Description Validations
Student_Grading_Scheme  Student_Grading_Scheme  [0..*]  Student Grading Scheme Wrapper Element   
top
 

Student_Grading_Scheme

part of: Student_Grading_Scheme_Response_Data
Student Grading Scheme Wrapper
 
Parameter name Type/Value Cardinality Description Validations
Student_Grading_Scheme_Reference  Student_Grading_SchemeObject  [0..1]  Student Grading Scheme Reference   
Student_Grading_Scheme_Data  Student_Grading_Scheme_Data  [0..*]  Student Grading Scheme Data Element   
top
 

Student_Grading_Scheme_Data

part of: Student_Grading_Scheme
Student Grading Scheme Data
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [1..1]  Grading Scheme Name 
Validation Description
Enter a Student Grading Scheme Name that isn't already in use.   
 
Effective_Date  date  [1..1]  Effective as of Date   
Student_Grade_Data  Student_Grade_Subedit_Data  [0..*]  Subelement of Student Grades 
Validation Description
Grade Notes Required can only be set if the Grade Category Type is Allow Grade Notes.   
 
top
 

Student_Grade_Subedit_Data

part of: Student_Grading_Scheme_Data
Student Grade Data Element
 
Parameter name Type/Value Cardinality Description Validations
Order  string  [0..1]  Student Grade Order   
ID  string  [0..1]  Student Grade ID   
Student_Grade_Element_Reference  Student_Grade_ElementObject  [1..1]  Student Grade Element Reference   
Grade_Points  decimal (6, 3) >0   [0..1]  Student Grade Grade Points   
Earn_Credits  boolean  [0..1]  Whether this Grade Earns Credits   
Include_in_GPA  boolean  [0..1]  Whether this Grade is Included in GPA   
Repeated_for_Grade_Improvement  boolean  [0..1]  Whether this Grade can be Repeated for Grade Improvement   
Student_Grade_Category_Type_Reference  Student_Grade_Category_TypeObject  [0..*]  Student Grade Category Type Reference   
Grade_Name  string  [0..1]  Student Grade Name   
Grade_Note_Required  boolean  [0..1]  Whether or not this Grade has required Grade Notes   
Validation Description
Grade Notes Required can only be set if the Grade Category Type is Allow Grade Notes.   
top
 

Student_Grade_ElementObject

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

Student_Grade_ElementObjectID

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

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

Student_Grade_Category_TypeObjectID

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

part of: Student_Grading_SchemeObjectID
Base Type
string
top
 

Student_Grade_ElementReferenceEnumeration

part of: Student_Grade_ElementObjectID
Base Type
string
top
 

Student_Grade_Category_TypeReferenceEnumeration

part of: Student_Grade_Category_TypeObjectID
Base Type
string
top