Service Directory > v32.1 > Financial_Aid > Import_Total_Financial_Assistance
 

Operation: Import_Total_Financial_Assistance

This task creates new financial aid packages with the supplied student award data for the given student on their record denoted by the institutional academic unit. The student awards on the request will override any current awards in the student's financial aid. Any student waivers or student sponsor contracts on an existing financial aid package will be added to the newly created package of the same academic period.


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

Element Container for Import Total Financial Assistance Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  The ID for the Total Financial Assistance Data Load   
Total_Financial_Assistance_Academic_Period_Data  Total_Financial_Assistance_Academic_Period_Data  [0..*]  Element container for the total financial assistance data for the given student, institutional academic unit, and academic period. 
Validation Description
The academic period must be within current and future financial aid award years.   
The academic period must be within the calendar of the student's primary program of study.   
The student must have a financial aid period record for the institutional academic unit and academic period.   
Student must have a financial aid record that has academic records in the institutional academic unit.   
Student cannot have more than one Work-Study Award with a Source of Institutional per Academic Period.   
Student cannot have more than one Work-Study Award with a Source of State per Academic Period.   
Student cannot have more than one Work-Study Award with a Source of Federal per Academic Period.   
Student cannot have more than two Work-Study awards of source Federal, Institutional, or State per academic period.   
 
Validation Description
Enter a Total Financial Assistance Data Load ID that is not already in use.   
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Total_Financial_Assistance_Academic_Period_Data

part of: Import_Total_Financial_Assistance_Request
Element container for the total financial assistance data for the given student, institutional academic unit, and academic period.
 
Parameter name Type/Value Cardinality Description Validations
Institutional_Academic_Unit_Reference  Academic_UnitObject  [1..1]  The Institutional Academic Unit to determine the financial aid record for the student to which this financial assistance data belongs.   
Student_Reference  StudentObject  [1..1]  The student receiving this financial assistance data.   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  The academic period for when this financial assistance data belongs.   
Total_Financial_Assistance_Student_Award_Data  Total_Financial_Assistance_Student_Award_Data  [0..*]  Element container for a Student Award within the Academic Period 
Validation Description
Use the loan application that matches this award item.   
Each borrower on a PLUS loan application must have a unique award sequence number. Select the award sequence number that matches the borrower.   
Select an award year that matches the one on the loan application.   
Select a loan application that matches this student.   
A loan application must be associated with this award before importing your data. Create a loan application to link with this award.   
 
Validation Description
The academic period must be within current and future financial aid award years.   
The academic period must be within the calendar of the student's primary program of study.   
The student must have a financial aid period record for the institutional academic unit and academic period.   
Student must have a financial aid record that has academic records in the institutional academic unit.   
Student cannot have more than one Work-Study Award with a Source of Institutional per Academic Period.   
Student cannot have more than one Work-Study Award with a Source of State per Academic Period.   
Student cannot have more than one Work-Study Award with a Source of Federal per Academic Period.   
Student cannot have more than two Work-Study awards of source Federal, Institutional, or State per academic period.   
top
 

Academic_UnitObject

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

Academic_UnitObjectID

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

StudentObject

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

Academic_PeriodObject

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

Academic_PeriodObjectID

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

Total_Financial_Assistance_Student_Award_Data

part of: Total_Financial_Assistance_Academic_Period_Data
Element container for a Student Award within the Academic Period
 
Parameter name Type/Value Cardinality Description Validations
Student_Award_Item_Reference  Student_Award_ItemObject  [1..1]  The student award item for this student award.   
Sequence  decimal (2, 0) >0   [1..1]  The sequence number for this student award.   
Amount_Awarded  decimal (14, 2) >0   [0..1]  The amount awarded for this student award.   
Amount_Accepted  decimal (12, 2) >0   [0..1]  The amount accepted for this student award.   
Student_Award_Status_Reference  Student_Award_StatusObject  [1..1]  The student award status for this student award.   
Student_Loan_Application_Reference  Student_Loan_ApplicationObject  [0..1]  The student loan application for this student award.   
Validation Description
Use the loan application that matches this award item.   
Each borrower on a PLUS loan application must have a unique award sequence number. Select the award sequence number that matches the borrower.   
Select an award year that matches the one on the loan application.   
Select a loan application that matches this student.   
A loan application must be associated with this award before importing your data. Create a loan application to link with this award.   
top
 

Student_Award_ItemObject

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

Student_Award_StatusObject

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

Student_Award_StatusObjectID

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

part of: Total_Financial_Assistance_Student_Award_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_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
 

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Student_Award_ItemReferenceEnumeration

part of: Student_Award_ItemObjectID
Base Type
string
top
 

Student_Award_StatusReferenceEnumeration

part of: Student_Award_StatusObjectID
Base Type
string
top
 

Student_Loan_ApplicationReferenceEnumeration

part of: Student_Loan_ApplicationObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top