Service Directory > v31.2 > Financial_Aid > Get_Student_Loan_Applications
 

Operation: Get_Student_Loan_Applications

Gets data about a Student Loan Application or all Student Loan Applications if a reference to one is not 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_Loan_Applications_Request

The request to get a Student Loan Application and its data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Loan_Application_Request_References  [0..1]  Contains references to Student Loan Applications   
Request_Criteria [Choice]   Student_Loan_Application_Request_Criteria  [0..1]  The criteria to get a Student Loan Application   
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_Loan_Applications_Response

The response for a Get Student Loan Application request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Loan_Application_Request_References  [0..1]  Contains references to Student Loan Applications   
Request_Criteria  Student_Loan_Application_Request_Criteria  [0..1]  The criteria to get a Student Loan Application   
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_Loan_Application_Response_Data  [0..1]  The response data for a Student Loan Application request   
top
 

Student_Loan_Application_Request_References

part of: Get_Student_Loan_Applications_Request, Get_Student_Loan_Applications_Response
Contains references to Student Loan Applications
 
Parameter name Type/Value Cardinality Description Validations
Student_Loan_Application_Reference  Student_Loan_ApplicationObject  [1..*]  Reference to Student Loan Applications   
top
 

Student_Loan_ApplicationObject

part of: Student_Loan_Application_Data, Student_Loan_Application_Request_References, Student_Loan_Application
 
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_Loan_ApplicationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Loan_ApplicationObjectID

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

part of: Get_Student_Loan_Applications_Request, Get_Student_Loan_Applications_Response
The criteria to get a Student Loan Application
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Loan_Applications_Request, Get_Student_Loan_Applications_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_Loan_Applications_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_Loan_Application_Response_Data

part of: Get_Student_Loan_Applications_Response
The response for a Student Loan Application request
 
Parameter name Type/Value Cardinality Description Validations
Student_Loan_Application  Student_Loan_Application  [0..*]  Wrapper element for the Student Loan Application Get Response   
top
 

Student_Loan_Application

part of: Student_Loan_Application_Response_Data
Wrapper element for the Student Loan Application Get Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Loan_Application_Reference  Student_Loan_ApplicationObject  [0..1]  Reference to a Student Loan Application   
Student_Loan_Application_Data  Student_Loan_Application_Data  [0..*]  Contains information about the referenced Student Loan Application. 
Validation Description
Enter a proxy that has a relationship of parent to the student.   
Entered Student must be matriculated.   
Enter either an Award Item of a Federal source with a Federal Program ID of either PLUS or Grad PLUS or an Award Item without a Federal Program ID that is not of a Federal source.   
You must enter either the maximum loan amount requested to be true or a loan amount requested amount.   
Enter a loan application end date on or after the loan application start date.   
Enter either a Loan Credit Status of Approved with no Loan Action Choice, or a Loan Credit Status of Pending or Denied with a Loan Action Choice.   
Enter an Award Item of type Loan.   
Enter an award item valid for the Student’s Academic Unit and Academic Level.   
Enter an Award Item with a Federal Program ID of PLUS Loan or Grad PLUS Loan when submitting a loan application with a Borrower.   
Enter a proxy with a relationship to the student.   
Enter a unique application identification.   
For a new application, enter a Previous Loan Application reference not yet updated by another loan application. For an existing application, enter the Previous Loan Application reference which is updated by this application.   
Enter an award item that is active.   
Enter a loan application reason of New Application when no reference to a previous loan application is provided. If a reference to a previous loan application is provided, enter a loan application reason of Loan Increase or Loan Decrease.   
You cannot edit the Student, Student Award Item, Financial Aid Award Year, and Student Proxy fields for an existing application.   
An application already matches the submitted fields for Student, Financial Aid Award Year, Student Award Item, and Student Proxy.   
The entered Student, Financial Aid Award Year, Student Award Item, and Student Proxy for this application do not match the fields for the entered previous application.   
Enter a Financial Aid Award Year within the attendance plan for the entered student.   
A Borrower Citizenship Status is required for Loan Applications with an Award Item that's Federal Program ID is PLUS   
A Date of Birth is required for Loan Applications with an Award Item that's Federal Program ID is PLUS   
Valid Citizenship Status' include U.S Citizen, Eligible Non-Citizen, or Not Eligible Only   
A Social Security Number is required for Loan Applications with an Award Item that's Federal Program ID is PLUS   
Please enter a Social Security Number that is 9 digits long.   
 
top
 

Student_Loan_Application_Data

part of: Student_Loan_Application
Contains information about the referenced Student Loan Application
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Student Loan Application   
Student_Reference  StudentObject  [1..1]  References a Student   
Student_Proxy_Reference  Student_ProxyObject  [0..1]  References a Student Proxy   
Student_Award_Item_Reference  Student_Award_ItemObject  [1..1]  References a Student Award Item   
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [1..1]  References a Financial Aid Award Year   
Maximum_Loan_Amount_Requested  boolean  [0..1]  Marks if the Maximum Loan Amount has been requested   
Student_Loan_Amount_Requested  decimal (11, 2) >0   [0..1]  Amount requested for the Student Loan Application   
Loan_Application_Reason_Reference  Student_Loan_Application_ReasonObject  [1..1]  References a Student Loan Application Reason   
Application_ID  decimal (10, 0) >0   [1..1]  Application ID for the Student Loan Application   
Loan_Application_Submission_Date  date  [1..1]  Submission Date for the Student Loan Application   
Previous_Student_Loan_Application_Reference  Student_Loan_ApplicationObject  [0..1]  References the Previous Student Loan Application that the current one is updating.   
Loan_Balance_Option_Reference  Student_Loan_Application_Balance_OptionObject  [1..1]  References a Student Loan Application Balance Option   
Loan_Credit_Status_Reference  Student_Loan_Application_Credit_StatusObject  [1..1]  References a Student Loan Application Credit Status   
Loan_Action_Choice_Reference  Student_Loan_Application_Action_ChoiceObject  [0..1]  References a Student Loan Application Action Choice   
Loan_Application_Start_Date  date  [1..1]  Start Date for the Student Loan Application   
Loan_Application_End_Date  date  [1..1]  End Date for the Student Loan Application   
Borrower_Date_of_Birth  date  [0..1]  Date of Birth for Borrower on the Loan Application   
Borrower_Social_Security_Number  string  [0..1]  Social Security Number for the Borrower on the Loan Application   
Borrower_Citizenship_Status_Reference  Financial_Aid_Citizenship_StatusObject  [0..1]  Citizenship Status for the Borrower on the Loan Application   
Validation Description
Enter a proxy that has a relationship of parent to the student.   
Entered Student must be matriculated.   
Enter either an Award Item of a Federal source with a Federal Program ID of either PLUS or Grad PLUS or an Award Item without a Federal Program ID that is not of a Federal source.   
You must enter either the maximum loan amount requested to be true or a loan amount requested amount.   
Enter a loan application end date on or after the loan application start date.   
Enter either a Loan Credit Status of Approved with no Loan Action Choice, or a Loan Credit Status of Pending or Denied with a Loan Action Choice.   
Enter an Award Item of type Loan.   
Enter an award item valid for the Student’s Academic Unit and Academic Level.   
Enter an Award Item with a Federal Program ID of PLUS Loan or Grad PLUS Loan when submitting a loan application with a Borrower.   
Enter a proxy with a relationship to the student.   
Enter a unique application identification.   
For a new application, enter a Previous Loan Application reference not yet updated by another loan application. For an existing application, enter the Previous Loan Application reference which is updated by this application.   
Enter an award item that is active.   
Enter a loan application reason of New Application when no reference to a previous loan application is provided. If a reference to a previous loan application is provided, enter a loan application reason of Loan Increase or Loan Decrease.   
You cannot edit the Student, Student Award Item, Financial Aid Award Year, and Student Proxy fields for an existing application.   
An application already matches the submitted fields for Student, Financial Aid Award Year, Student Award Item, and Student Proxy.   
The entered Student, Financial Aid Award Year, Student Award Item, and Student Proxy for this application do not match the fields for the entered previous application.   
Enter a Financial Aid Award Year within the attendance plan for the entered student.   
A Borrower Citizenship Status is required for Loan Applications with an Award Item that's Federal Program ID is PLUS   
A Date of Birth is required for Loan Applications with an Award Item that's Federal Program ID is PLUS   
Valid Citizenship Status' include U.S Citizen, Eligible Non-Citizen, or Not Eligible Only   
A Social Security Number is required for Loan Applications with an Award Item that's Federal Program ID is PLUS   
Please enter a Social Security Number that is 9 digits long.   
top
 

StudentObject

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

Student_ProxyObject

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

Student_ProxyObjectID

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

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

Student_Award_ItemObjectID

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

Financial_Aid_Award_YearObject

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

Financial_Aid_Award_YearObjectID

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

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

Student_Loan_Application_ReasonObjectID

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

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

Student_Loan_Application_Balance_OptionObjectID

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

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

Student_Loan_Application_Credit_StatusObjectID

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

Student_Loan_Application_Action_ChoiceObject

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

Student_Loan_Application_Action_ChoiceObjectID

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

Financial_Aid_Citizenship_StatusObject

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

Financial_Aid_Citizenship_StatusObjectID

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

Student_Loan_ApplicationReferenceEnumeration

part of: Student_Loan_ApplicationObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Student_ProxyReferenceEnumeration

part of: Student_ProxyObjectID
Base Type
string
top
 

Student_Award_ItemReferenceEnumeration

part of: Student_Award_ItemObjectID
Base Type
string
top
 

Financial_Aid_Award_YearReferenceEnumeration

part of: Financial_Aid_Award_YearObjectID
Base Type
string
top
 

Student_Loan_Application_ReasonReferenceEnumeration

part of: Student_Loan_Application_ReasonObjectID
Base Type
string
top
 

Student_Loan_Application_Balance_OptionReferenceEnumeration

part of: Student_Loan_Application_Balance_OptionObjectID
Base Type
string
top
 

Student_Loan_Application_Credit_StatusReferenceEnumeration

part of: Student_Loan_Application_Credit_StatusObjectID
Base Type
string
top
 

Student_Loan_Application_Action_ChoiceReferenceEnumeration

part of: Student_Loan_Application_Action_ChoiceObjectID
Base Type
string
top
 

Financial_Aid_Citizenship_StatusReferenceEnumeration

part of: Financial_Aid_Citizenship_StatusObjectID
Base Type
string
top