Service Directory > v32.1 > Financial_Aid > Put_Student_Loan_Application
 

Operation: Put_Student_Loan_Application

Creates a new Student Loan Application (or updates an existing Student Loan Application) with the information supplied in the request.


@ - 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: Put_Student_Loan_Application_Request

Wrapper element for the Put Student Loan Application returned data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Student_Loan_Application_Reference  Student_Loan_ApplicationObject  [0..1]  Student Loan Application Reference   
Student_Loan_Application_Data  Student_Loan_Application_Data  [1..1]  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 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.   
Change the Balance Option to Student. The recipient of credit balances for Graduate PLUS Loans must always be the student.   
Provide a Student Proxy for Parent PLUS Loans.   
Enter an Award Item with a Federal Program ID of PLUS Loan when submitting a loan application with a Borrower.   
Provide a Balance Option of Student or Borrower for Parent PLUS Loans.   
 
Validation Description
The web service is set to add only, but the Student Loan Application already exists.   
top
 

Response Element: Put_Student_Loan_Application_Response

Documentation Response for the Put Student Loan Application Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Loan_Application_Reference  Student_Loan_ApplicationObject  [0..1]  Response for Put Student Loan Application Request   
top
 

Student_Loan_ApplicationObject

part of: Student_Loan_Application_Data, Put_Student_Loan_Application_Request, Put_Student_Loan_Application_Response
 
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_Data

part of: Put_Student_Loan_Application_Request
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  [0..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 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.   
Change the Balance Option to Student. The recipient of credit balances for Graduate PLUS Loans must always be the student.   
Provide a Student Proxy for Parent PLUS Loans.   
Enter an Award Item with a Federal Program ID of PLUS Loan when submitting a loan application with a Borrower.   
Provide a Balance Option of Student or Borrower for Parent PLUS Loans.   
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