Service Directory > v31.2 > Financial_Aid > Import_Legacy_Financial_Aid_Packages
 

Operation: Import_Legacy_Financial_Aid_Packages

Imports Legacy Financial Aid Packages. Workday will provide a web service implementers can use to import student packaging results from their legacy system. If any validations fail during the import, the line containing the validation should be skipped and not imported.


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

Top Level Element to start an Import Legacy Financial Aid Packages task.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  Reference ID for the Legacy Financial Aid Package Data Load.   
Student_Legacy_Package_Data  Import_Legacy_Financial_Aid_Package_Student_Data  [0..*]  Contains the data to determine which student there will be Legacy Financial Aid Packages imported for. 
Validation Description
Student has more than one Financial Aid Record. Please submit Financial Aid Record Reference.   
Submit either Student Reference or Financial Aid Record Reference.   
Entered Student must be matriculated.   
 
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
 

Import_Legacy_Financial_Aid_Package_Student_Data

part of: Import_Legacy_Financial_Aid_Package_Request
Contains the data to determine which student there will be Legacy Financial Aid Packages imported for.
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  This is the Student Reference (or file) that will designate which Financial Aid Period Record the Legacy Financial Aid Packages will be imported on.   
Financial_Aid_Record_Reference  Financial_Aid_RecordObject  [0..1]  This is the Financial Aid Record the Legacy Financial Aid Packages will be imported on.   
Legacy_Financial_Aid_Package_Data  Import_Legacy_FA_Package_-_Legacy_Financial_Aid_Package_Data  [1..*]  Data Required to determine the correct Student Period Record and import Legacy Financial Aid Packages. 
Validation Description
No Financial Aid Period Record found for the given Student or Financial Aid Record and Academic Period.   
 
Validation Description
Student has more than one Financial Aid Record. Please submit Financial Aid Record Reference.   
Submit either Student Reference or Financial Aid Record Reference.   
Entered Student must be matriculated.   
top
 

StudentObject

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

Financial_Aid_RecordObject

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

Financial_Aid_RecordObjectID

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

Import_Legacy_FA_Package_-_Legacy_Financial_Aid_Package_Data

part of: Import_Legacy_Financial_Aid_Package_Student_Data
Data Required to determine the correct Student Period Record and import Legacy Financial Aid Packages.
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Package_Date  dateTime  [0..1]  Legacy Financial Aid Package Date.   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period used to determine the Student Period Record.   
Cost_of_Attendance  decimal (14, 2)   [0..1]  Legacy COA.   
EFC  decimal (14, 2)   [0..1]  Legacy EFC.   
Legacy_Student_Award_Data  Import_Legacy_FA_Package_-_Legacy_Student_Award_Data  [1..*]  Data Required to determine the correct Legacy Financial Aid Package and import Legacy Student Awards. 
Validation Description
The Legacy Amount Disbursed must be greater than zero.   
The Legacy Award Amount must be greater than zero.   
The Legacy Accepted Amount must be greater than zero.   
 
Validation Description
No Financial Aid Period Record found for the given Student or Financial Aid Record and Academic Period.   
top
 

Academic_PeriodObject

part of: Import_Legacy_FA_Package_-_Legacy_Financial_Aid_Package_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
 

Import_Legacy_FA_Package_-_Legacy_Student_Award_Data

part of: Import_Legacy_FA_Package_-_Legacy_Financial_Aid_Package_Data
Data Required to determine the correct Legacy Financial Aid Package and import Legacy Student Awards.
 
Parameter name Type/Value Cardinality Description Validations
Student_Award_Item_Reference  Student_Award_ItemObject  [1..1]  Student Award Item used in tandem with a Legacy Financial Aid Package to determine whether or not a Legacy Student Award already exists, and if not, creates one.   
Award_Amount  decimal (14, 2)   [1..1]  Legacy Award Amount.   
Accepted_Amount  decimal (14, 2)   [1..1]  Legacy Award Amount Accepted.   
Amount_Disbursed  decimal (14, 2)   [1..1]  Legacy Award Amount Disbursed.   
Validation Description
The Legacy Amount Disbursed must be greater than zero.   
The Legacy Award Amount must be greater than zero.   
The Legacy Accepted Amount must be greater than zero.   
top
 

Student_Award_ItemObject

part of: Import_Legacy_FA_Package_-_Legacy_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
 

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
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Financial_Aid_RecordReferenceEnumeration

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

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top