Service Directory > v32.1 > Academic_Advising > Get_Academic_Progress_for_Student
 

Operation: Get_Academic_Progress_for_Student

This web service will retrieve Academic Progress for currently enrolled students with Program of Study.


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

Get Student Academic Progress Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Academic_Progress_Request_References  [0..1]  Student Academic Requirement Assignment Request References   
Request_Criteria [Choice]   Student_Academic_Progress_Request_Criteria  [0..1]  Student Academic Requirement Assignment 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_Academic_Progress_for_Student_Response

Get Student Academic Progress Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Academic_Progress_Request_References  [0..1]  Student Academic Requirement Assignment Request References   
Request_Criteria  Student_Academic_Progress_Request_Criteria  [0..1]  Student Academic Requirement Assignment Request Criteria   
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_Academic_Progress_Response_Data  [0..1]  Student Academic Requirement Assignment Response Data   
top
 

Student_Academic_Progress_Request_References

part of: Get_Academic_Progress_for_Student_Request, Get_Academic_Progress_for_Student_Response
Student Academic Progress Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..*]  Student Academic Requirement Assignment Reference   
top
 

StudentObject

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

StudentObjectID

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

part of: Get_Academic_Progress_for_Student_Request, Get_Academic_Progress_for_Student_Response
Student Academic Progress Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference [Choice]   Program_of_StudyObject  [0..*]  Student Reference   
Program_of_Study_Type_Category_Reference [Choice]   Program_of_Study_Type_CategoryObject  [0..*]  Program of Study Type Category   
top
 

Program_of_StudyObject

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

Program_of_StudyObjectID

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

Program_of_Study_Type_CategoryObject

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

Program_of_Study_Type_CategoryObjectID

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

part of: Get_Academic_Progress_for_Student_Response
Student Academic Progress Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Academic_Progress  Student_Academic_Progress  [0..*]  Student Academic Requirement Assignment   
top
 

Student_Academic_Progress

part of: Student_Academic_Progress_Response_Data
Student Academic Progress
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Reference   
Academic_Record_Student_Academic_Progress_Data  Academic_Record_Student_Academic_Progress_Data  [0..*]  Student Record Academic Progress Data   
top
 

Academic_Record_Student_Academic_Progress_Data

part of: Student_Academic_Progress
Student Record Academic Progress Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Record_Reference  Academic_RecordObject  [0..1]  Student Record Reference   
Program_of_Study_Student_Academic_Progress_Data  Program_of_Study_Student_Academic_Progress_Data  [0..*]  Program of Study Student Academic Progress Data   
top
 

Academic_RecordObject

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

Academic_RecordObjectID

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

Program_of_Study_Student_Academic_Progress_Data

part of: Academic_Record_Student_Academic_Progress_Data
Program of Study Student Academic Progress Data
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference  Program_of_StudyObject  [0..1]  Program of Study Reference   
Program_of_Study_Type_Category_Reference  Program_of_Study_Type_CategoryObject  [0..1]  Program of Study Type Category Reference   
Requirement_Area_Data  Student_Conditional_Assignment_Inheritable_Academic_Progress_Data  [0..*]  Student Conditional Inheritable Academic Progress Data Reference   
top
 

Student_Conditional_Assignment_Inheritable_Academic_Progress_Data

part of: Program_of_Study_Student_Academic_Progress_Data
Student Conditional Assignment Inheritable Academic Progress Data
 
Parameter name Type/Value Cardinality Description Validations
Requirement_Area_Reference  Academic_Unit_Policy_InheritableObject  [0..1]  Requirement Area Reference   
Requirement_Area_Name  string  [0..1]  Requirement Area Name   
Student_Academic_Progress_Data_Reference  Student_Academic_Progress_Data  [0..*]  Student Academic Progress Data   
top
 

Academic_Unit_Policy_InheritableObject

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

Academic_Unit_Policy_InheritableObjectID

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

part of: Student_Conditional_Assignment_Inheritable_Academic_Progress_Data
Student Academic Progress Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Academic_Requirement_Assignment_Reference  Unique_IdentifierObject  [0..1]  Student Academic Requirement Assignment Reference   
Academic_Requirement_Reference  Academic_RequirementObject  [0..1]  Academic Requirement Name   
Academic_Requirement_Name  string  [0..1]  Academic Requirement Reference   
Requirement_Completion_Status_Reference  Requirement_Completion_StatusObject  [0..*]  Requirement Completion Status Reference   
Satisfied_With_Reference  Academic_Progress_SatisfiableObject  [0..*]  Instances that satisfy this Academic Requirement, including Completed Student Course Registrations   
Satisfied_With_In_Progress_Reference  Student_Course_RegistrationObject  [0..*]  Instances that satisfy this Academic Requirement, including Non-Completed (In Progress) Student Course Registrations   
Remaining  string  [0..1]  Remaining Courses   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

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

Academic_RequirementObjectID

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

Requirement_Completion_StatusObject

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

Requirement_Completion_StatusObjectID

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

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

Academic_Progress_SatisfiableObjectID

part of: Academic_Progress_SatisfiableObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Competency_ID, Course_Listing_ID, Education_Test_Result_ID, Learning_Outcome_ID, Program_of_Study_ID, Student_Activity_Registration_Record_ID, Student_Course_Registration_ID, Student_Prospect_Record_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_Course_RegistrationObject

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

Student_Course_RegistrationObjectID

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

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

Program_of_Study_Type_CategoryReferenceEnumeration

part of: Program_of_Study_Type_CategoryObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Academic_Unit_Policy_InheritableReferenceEnumeration

part of: Academic_Unit_Policy_InheritableObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Academic_RequirementReferenceEnumeration

part of: Academic_RequirementObjectID
Base Type
string
top
 

Requirement_Completion_StatusReferenceEnumeration

part of: Requirement_Completion_StatusObjectID
Base Type
string
top
 

Academic_Progress_SatisfiableReferenceEnumeration

part of: Academic_Progress_SatisfiableObjectID
Base Type
string
top
 

Student_Course_RegistrationReferenceEnumeration

part of: Student_Course_RegistrationObjectID
Base Type
string
top