Service Directory > v32.1 > Student_Finance > Get_Student_Account_Summary
 

Operation: Get_Student_Account_Summary

Get the account summary for a given student including his/her total account balance and anticipated aid.


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

Wrapper element for Get Student Account Summary Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Account_Summary_Request_References  [1..1]  Element containing the list of Students for which data is requested.   
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_Account_Summary_Response

Wrapper element for Get Student Account Summary Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Account_Summary_Request_References  [0..1]  Element containing the list of Students for which data is requested.   
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_Account_Summary_Response_Data  [0..1]  Wrapper element for Student Account Summary Response   
top
 

Student_Account_Summary_Request_References

part of: Get_Student_Account_Summary_Request, Get_Student_Account_Summary_Response
Element containing the list of Students for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Students_Reference  StudentObject  [1..*]  Student for which Account Summary Information is requested   
top
 

StudentObject

part of: Student_Account_Summary_Request_References, Student_Financial_Account, Student_Financial_Account_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  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
 

Response_Filter

part of: Get_Student_Account_Summary_Request, Get_Student_Account_Summary_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_Account_Summary_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_Account_Summary_Response_Data

part of: Get_Student_Account_Summary_Response
Wrapper element for Student Account Summary Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Financial_Account  Student_Financial_Account  [0..*]  Wrapper for Student Account Summary Get Response   
top
 

Student_Financial_Account

part of: Student_Account_Summary_Response_Data
Wrapper for Student Account Summary Get Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Financial Account reference   
Student_Financial_Account_Data  Student_Financial_Account_Data  [0..*]  Wrapper element for Student Financial Account Data   
top
 

Student_Financial_Account_Data

part of: Student_Financial_Account
Wrapper element for Student Financial Account Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Reference   
First_Name  string  [0..1]  First name of the student   
Last_Name  string  [0..1]  Last name of the student   
Email_Address  string  [0..1]  Email address of the student   
Account_Balance  decimal (30, 10)   [0..1]  Total account balance of the student including payments, charges, and refunds   
Anticipated_Aid  decimal (12, 2)   [0..1]  Total amount of anticipated financial aid which is not yet disbursed   
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top