Service Directory > v32.1 > Financial_Aid > Import_Student_Additional_Data_for_Student_and_Academic_Period
 

Operation: Import_Student_Additional_Data_for_Student_and_Academic_Period

This task edits the Student Additional Data fields for existing Student Period Records by Student reference and Academic Period reference. It will use the student's active student record and pick the Student Period Record based on 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_Student_Additional_Data_for_Student_and_Academic_Period_Request

Request for the high volume import request for Student Additional Data for Student Period Records
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  Reference ID for the Data Load   
Student_Additional_Data  Student_Period_Record_Student_Additional_Data_Data  [0..*]  Container element for the Student Additional Data attributes and Student Additional Data Payment sources 
Validation Description
No Student Period Record exists for the Student and Academic Period.   
Cannot set Institutional EFC Not Blank to false and set Institutional EFC to a non-zero value.   
Cannot set Parent EFC Not Blank to false and set Parent EFC to a non-zero value.   
Cannot set Parent EFC without also setting Parent EFC Not Blank to true.   
Cannot set Institutional EFC without also setting Institutional EFC Not Blank to true.   
 
Validation Description
Enter a Student Period Record Student Additional Data 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
 

Student_Period_Record_Student_Additional_Data_Data

part of: Import_Student_Additional_Data_for_Student_and_Academic_Period_Request
Container element for the Student Additional Data attributes and Student Additional Data Payment sources
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  Student Reference   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period Reference   
Financial_Aid_Index  decimal (6, 0) >0   [0..1]  Financial Aid Index   
Financial_Aid_Number  decimal (6, 0) >0   [0..1]  Financial Aid Number   
Institutional_EFC_Not_Blank  boolean  [0..1]  True if the Institutional EFC field is not blank   
Institutional_EFC  decimal (6, 0) >0   [0..1]  The student's institutional expected family contribution for the academic period   
Parent_EFC_Not_Blank  boolean  [0..1]  True if the Parent EFC field is not blank   
Parent_EFC  decimal (6, 0) >0   [0..1]  The student's parents' expected family contribution for the academic period   
Payment_Source_1_Data  Student_Additional_Data_Payment_Source_1_Data  [0..1]  Wrapper element for the Payment Source Data for Payment Source 1   
Payment_Source_2_Data  Student_Additional_Data_Payment_Source_2_Data  [0..1]  Wrapper element for the Payment Source Data for Payment Source 2   
Payment_Source_3_Data  Student_Additional_Data_Payment_Source_3_Data  [0..1]  Wrapper element for the Payment Source Data for Payment Source 3   
Validation Description
No Student Period Record exists for the Student and Academic Period.   
Cannot set Institutional EFC Not Blank to false and set Institutional EFC to a non-zero value.   
Cannot set Parent EFC Not Blank to false and set Parent EFC to a non-zero value.   
Cannot set Parent EFC without also setting Parent EFC Not Blank to true.   
Cannot set Institutional EFC without also setting Institutional EFC Not Blank to true.   
top
 

StudentObject

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

Student_Additional_Data_Payment_Source_1_Data

part of: Student_Period_Record_Student_Additional_Data_Data
Wrapper element for the Payment Source Data for Payment Source 1
 
Parameter name Type/Value Cardinality Description Validations
Payment_Source_Data  Student_Additional_Data_Payment_Source_Data  [0..1]  Container element for the data on a Student Additional Data Payment Source   
top
 

Student_Additional_Data_Payment_Source_Data

part of: Student_Additional_Data_Payment_Source_2_Data, Student_Additional_Data_Payment_Source_3_Data, Student_Additional_Data_Payment_Source_1_Data
Container element for the data on a Student Additional Data Payment Source
 
Parameter name Type/Value Cardinality Description Validations
Use_Not_Requested  boolean  [0..1]  Use Not Requested   
Internal_Available_Academic_Periods  decimal (2, 0) >0   [0..1]  Internal Available Academic Periods   
External_Available_Academic_Periods  decimal (2, 0) >0   [0..1]  External Available Academic Periods   
Internal_Available_Academic_Hours  decimal (3, 0) >0   [0..1]  Internal Available Academic Hours   
External_Available_Academic_Hours  decimal (3, 0) >0   [0..1]  External Available Academic Hours   
Payment_Source_Plan_Type_Reference  Payment_Source_Plan_TypeObject  [0..1]  Payment Source Plan Type Reference   
Payment_Source_Payment_Status_Reference  Payment_Source_Payment_StatusObject  [0..1]  Payment Source Payment Status Reference   
top
 

Payment_Source_Plan_TypeObject

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

Payment_Source_Plan_TypeObjectID

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

Payment_Source_Payment_StatusObject

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

Payment_Source_Payment_StatusObjectID

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

part of: Student_Period_Record_Student_Additional_Data_Data
Wrapper element for the Payment Source Data for Payment Source 2
 
Parameter name Type/Value Cardinality Description Validations
Payment_Source_Data  Student_Additional_Data_Payment_Source_Data  [0..*]  Container element for the data on a Student Additional Data Payment Source   
top
 

Student_Additional_Data_Payment_Source_3_Data

part of: Student_Period_Record_Student_Additional_Data_Data
Wrapper element for the Payment Source Data for Payment Source 3
 
Parameter name Type/Value Cardinality Description Validations
Payment_Source_Data  Student_Additional_Data_Payment_Source_Data  [0..*]  Container element for the data on a Student Additional Data Payment Source   
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
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Payment_Source_Plan_TypeReferenceEnumeration

part of: Payment_Source_Plan_TypeObjectID
Base Type
string
top
 

Payment_Source_Payment_StatusReferenceEnumeration

part of: Payment_Source_Payment_StatusObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top