Service Directory > v31.2 > Academic_Foundation > Get_Educational_Institution_Grading_Schemes
 

Operation: Get_Educational_Institution_Grading_Schemes

Returns Educational Institution Grading Scheme by Reference ID, or returns all External Institution Grading Schemes 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_Educational_Institution_Grading_Schemes_Request

Get Educational Institution Grading Scheme Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Educational_Institution_Grading_Scheme_Request_References  [0..1]  Request References   
Response_Filter  Response_Filter  [0..1]  Request Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Educational_Institution_Grading_Schemes_Response

Get Educational Institution Grading Schemes Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Educational_Institution_Grading_Scheme_Request_References  [0..1]  Element Container for Educational Institution Grading Scheme Request References   
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  Educational_Institution_Grading_Scheme_Response_Data  [0..1]  Element Container for Educational Institution Grading Scheme Response Data   
top
 

Educational_Institution_Grading_Scheme_Request_References

part of: Get_Educational_Institution_Grading_Schemes_Response, Get_Educational_Institution_Grading_Schemes_Request
Educational Institution Grading Scheme Request References Element
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Grading_Scheme_Reference  External_Institution_Grading_SchemeObject  [1..*]  Educational Institution Grading Scheme Reference   
top
 

External_Institution_Grading_SchemeObject

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

External_Institution_Grading_SchemeObjectID

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

Response_Filter

part of: Get_Educational_Institution_Grading_Schemes_Response, Get_Educational_Institution_Grading_Schemes_Request
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_Educational_Institution_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
 

Educational_Institution_Grading_Scheme_Response_Data

part of: Get_Educational_Institution_Grading_Schemes_Response
Educational Institution Grading Scheme Response Data
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Grading_Scheme  Educational_Institution_Grading_Scheme  [0..*]  Educational Institution Grading Scheme   
top
 

Educational_Institution_Grading_Scheme

part of: Educational_Institution_Grading_Scheme_Response_Data
Educational Institution Grading Scheme Element
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Grading_Scheme_Reference  External_Institution_Grading_SchemeObject  [0..1]  The Educational Institution Grading Scheme reference   
Educational_Institution_Grading_Scheme_Data  Educational_Institution_Grading_Scheme_Data  [0..*]  Element Container for Educational Institution Grading Scheme Data 
Validation Description
Provide an educational institution grading scheme code that is not already in use.   
Grading Scheme Grade References should be unique for a Grading Scheme.   
 
top
 

Educational_Institution_Grading_Scheme_Data

part of: Educational_Institution_Grading_Scheme
Element containing information for the Educational Institution Grading Scheme being added or updated.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Educational Institution Grading Scheme   
Grading_Scheme_Code  string  [1..1]  Educational Institution Grading Scheme Code   
Grading_Scheme_Description  string  [0..1]  Educational Institution Grading Scheme Description   
Educational_Institution_Grading_Scheme_Component_Data  Educational_Institution_Grading_Scheme_Component_Data  [1..*]  Element Container for Educational Institution Grading Scheme Component 
Validation Description
The Educational Institution Grading Scheme Component ID you are referencing should belong to this Educational Institution Grading Scheme.   
 
Validation Description
Provide an educational institution grading scheme code that is not already in use.   
Grading Scheme Grade References should be unique for a Grading Scheme.   
top
 

Educational_Institution_Grading_Scheme_Component_Data

part of: Educational_Institution_Grading_Scheme_Data
Element containing information for the Educational Institution Grading Scheme Component
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference to the Educational Institution Grading Scheme Component   
Grading_Scheme_Grade_Reference  External_Institution_Grading_Scheme_Grade__All_Object  [1..1]  Reference to the Educational Institution Grading Scheme Grades   
Grade_Point_Value_Reference  External_Institution_Grading_Scheme_Grade_Point_ValueObject  [1..1]  Reference to the Educational Institution Grading Scheme Grade Point Value   
Grading_Scheme_Configuration_Reference  External_Institution_Grading_Scheme_ConfigurationObject  [0..1]  Reference to the Educational Institution Grading Scheme Configuration   
Validation Description
The Educational Institution Grading Scheme Component ID you are referencing should belong to this Educational Institution Grading Scheme.   
top
 

External_Institution_Grading_Scheme_Grade__All_Object

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

External_Institution_Grading_Scheme_Grade__All_ObjectID

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

External_Institution_Grading_Scheme_Grade_Point_ValueObject

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

External_Institution_Grading_Scheme_Grade_Point_ValueObjectID

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

External_Institution_Grading_Scheme_ConfigurationObject

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

External_Institution_Grading_Scheme_ConfigurationObjectID

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

External_Institution_Grading_SchemeReferenceEnumeration

part of: External_Institution_Grading_SchemeObjectID
Base Type
string
top
 

External_Institution_Grading_Scheme_Grade__All_ReferenceEnumeration

part of: External_Institution_Grading_Scheme_Grade__All_ObjectID
Base Type
string
top
 

External_Institution_Grading_Scheme_Grade_Point_ValueReferenceEnumeration

part of: External_Institution_Grading_Scheme_Grade_Point_ValueObjectID
Base Type
string
top
 

External_Institution_Grading_Scheme_ConfigurationReferenceEnumeration

part of: External_Institution_Grading_Scheme_ConfigurationObjectID
Base Type
string
top