Service Directory > v32.1 > Admissions > Get_Student_Application_GPAs
 

Operation: Get_Student_Application_GPAs

Returns Student Application GPAs by Reference ID, or returns all Student Application GPAs 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_GPAs_Request

Element container for Get Student Application GPAs Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Application_GPA_Request_References  [0..1]  Element Container for Student Application GPA Request References   
Request_Criteria [Choice]   Student_Application_GPA_Request_Criteria  [0..1]  Element Container for Student Application GPA Request Criteria   
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. 
 
top
 

Response Element: Get_Student_Application_GPAs_Response

Element Container for Get Student Application GPAs Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Application_GPA_Request_References  [0..1]  Element Container for Student Application GPA Request References   
Request_Criteria  Student_Application_GPA_Request_Criteria  [0..1]  Element Container for Student Application GPA Request Criteria   
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_Response_Data  [0..1]  Element Container for Student Application GPA Response Data   
top
 

Student_Application_GPA_Request_References

part of: Get_Student_Application_GPAs_Response, Get_Student_Application_GPAs_Request
Element Container for Student Application GPA Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_GPA_Reference  Student_Application_GPAObject  [1..*]  Work Set containing Student Application GPAs   
top
 

Student_Application_GPAObject

part of: Student_Application_GPA_Request_References, Student_Application_GPA
 
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
 

Student_Application_GPA_Request_Criteria

part of: Get_Student_Application_GPAs_Response, Get_Student_Application_GPAs_Request
Element Container for Student Application GPA Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Application_GPAs_Response, Get_Student_Application_GPAs_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_GPAs_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_Response_Data

part of: Get_Student_Application_GPAs_Response
Element Container for Student Application GPA Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_GPA  Student_Application_GPA  [0..*]  Element Content for Student Application GPA   
top
 

Student_Application_GPA

part of: Student_Application_GPA_Response_Data
Element Content for Student Application GPA
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_GPA_Reference  Student_Application_GPAObject  [0..1]  Work Set containing a single instance of a Student Application GPA   
Student_Application_GPA_Data  Student_Application_GPA_Data  [0..*]  Element Content for Student GPA Application Data   
top
 

Student_Application_GPA_Data

part of: Student_Application_GPA
Element container for Student Application GPA Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Index ID for Student Application GPA   
Student_Application_GPA_Name  string (100)   [1..1]  Name for Student Application GPA   
Student_Application_GPA_Description  RichText  [0..1]  Description for Student Application GPA   
Student_Application_GPA_Inactive  boolean  [0..1]  Inactive Boolean for Student Application GPA   
Academic_Unit_Data  Has_Academic_Unit_with_Shareable_Subordinates_Data  [1..*]  Academic Unit Data 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Educational_Institution_Course_Academic_Area_Reference  Educational_Institution_Course_Academic_AreaObject  [0..*]  References to Educational Institution Course Academic Area   
Student_External_Transcript_Course_Record_Level_Reference  Student_External_Transcript_Course_Record_LevelObject  [0..*]  References to Student External Transcript Course Record Level.   
Educational_Institution_Course_Designation_Reference  Educational_Institution_Course_DesignationObject  [0..*]  References to Educational Institution Course Designation.   
top
 

Has_Academic_Unit_with_Shareable_Subordinates_Data

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

Educational_Institution_Course_Academic_AreaObject

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

Educational_Institution_Course_Academic_AreaObjectID

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

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

Student_External_Transcript_Course_Record_LevelObjectID

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

Educational_Institution_Course_DesignationObject

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

Educational_Institution_Course_DesignationObjectID

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

part of: Student_Application_GPAObjectID
Base Type
string
top
 

RichText

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

Educational_Institution_Course_Academic_AreaReferenceEnumeration

part of: Educational_Institution_Course_Academic_AreaObjectID
Base Type
string
top
 

Student_External_Transcript_Course_Record_LevelReferenceEnumeration

part of: Student_External_Transcript_Course_Record_LevelObjectID
Base Type
string
top
 

Educational_Institution_Course_DesignationReferenceEnumeration

part of: Educational_Institution_Course_DesignationObjectID
Base Type
string
top