Service Directory > v32.1 > Admissions > Get_Student_Application_GPA_Eligibility_Rules
 

Operation: Get_Student_Application_GPA_Eligibility_Rules

Returns Student Application GPA Eligibility Rules by Reference ID. Returns all Student Application GPA Eligibility Rules 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_Application_GPA_Eligibility_Rules_Request

Request Element to get Student Application GPA Eligibility Rule
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Application_GPA_Eligibility_Rule_Request_References  [0..1]  Element Container for Student Application GPA Eligibility Rule 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. 
 
top
 

Response Element: Get_Student_Application_GPA_Eligibility_Rules_Response

Entire response element for the Get Student Application GPA Eligibility Rule Web Service task.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Application_GPA_Eligibility_Rule_Request_References  [0..1]  Reference to Student Application GPA Eligibility Rule.   
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_Application_GPA_Eligibility_Rule_Response_Data  [0..1]  Response for the Student Application GPA Eligibility Rule Get Request.   
top
 

Student_Application_GPA_Eligibility_Rule_Request_References

part of: Get_Student_Application_GPA_Eligibility_Rules_Response, Get_Student_Application_GPA_Eligibility_Rules_Request
Reference to Student Application GPA Eligibility Rule.
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_GPA_Eligibility_Rule_Reference  Student_Eligibility_RuleObject  [1..*]  The Student Application GPA Eligibility Rule being requested.   
top
 

Student_Eligibility_RuleObject

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

Student_Eligibility_RuleObjectID

part of: Student_Eligibility_RuleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Eligibility_Rule_ID, Student_Condition_Rule_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_Application_GPA_Eligibility_Rules_Response, Get_Student_Application_GPA_Eligibility_Rules_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_Student_Application_GPA_Eligibility_Rules_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_Application_GPA_Eligibility_Rule_Response_Data

part of: Get_Student_Application_GPA_Eligibility_Rules_Response
Response for the Student Application GPA Eligibility Rule Get Request.
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_GPA_Eligibility_Rule  Student_Application_GPA_Eligibility_Rule  [0..*]  Response Data for Get Student Application GPA Eligibility Rule Web Service Task.   
top
 

Student_Application_GPA_Eligibility_Rule

part of: Student_Application_GPA_Eligibility_Rule_Response_Data
Response Data for Get Student Application GPA Eligibility Rule Web Service Task.
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_GPA_Eligibility_Rule_Reference  Student_Eligibility_RuleObject  [0..1]  Student Application GPA Eligibility Rule being returned.   
Student_Application_GPA_Eligibility_Rule_Data  Student_Application_GPA_Eligibility_Rule_Data  [0..*]  Element Container for Student Application GPA Eligibility Rule Data.   
top
 

Student_Application_GPA_Eligibility_Rule_Data

part of: Student_Application_GPA_Eligibility_Rule
Contains returned data for the Student Application GPA Eligibility Rule.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID of the Student Application GPA Eligibility Rule.   
Rule_Name  string  [1..1]  Name of the Student Application GPA Eligibility Rule.   
Academic_Unit_Data  Academic_Curricular_Division_Subedit_Level_Optional_Data  [1..1]  Element Container for Academic Division Subedit Level Optional Data. 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Excludes  boolean  [0..1]  Boolean indicating whether Student Application GPA Eligibility Rule excludes.   
Student_Application_GPA_Reference  Student_Application_GPAObject  [1..1]  Student Application GPA of the Student Application GPA Eligibility Rule.   
Relational_Operator_Reference  Relational_OperatorObject  [1..1]  Relational Operator of the Student Application GPA Eligibility Rule.   
GPA_comparable  decimal (6, 2) >0   [1..1]  The comparable GPA of the Student Application GPA Eligibility Rule.   
top
 

Academic_Curricular_Division_Subedit_Level_Optional_Data

part of: Student_Application_GPA_Eligibility_Rule_Data
Contains Academic Unit information for a Student Prospect where the Academic Level is optional
 
Parameter name Type/Value Cardinality Description Validations
Academic_Level_Reference  Academic_LevelObject  [0..1]  References an Academic Level for a Student Prospect   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit Reference 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_LevelObject

part of: Academic_Curricular_Division_Subedit_Level_Optional_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_Curricular_DivisionObject

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

Student_Application_GPAObject

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

Student_Application_GPAObjectID

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

Relational_OperatorObject

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

Relational_OperatorObjectID

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

part of: Student_Eligibility_RuleObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Student_Application_GPAReferenceEnumeration

part of: Student_Application_GPAObjectID
Base Type
string
top
 

Relational_OperatorReferenceEnumeration

part of: Relational_OperatorObjectID
Base Type
string
top