Service Directory > v31.2 > Financial_Aid > Get_Student_Additional_Data_for_Student_and_Academic_Period
 

Operation: Get_Student_Additional_Data_for_Student_and_Academic_Period

Get Student Additional Data for Student Period Records by Student Reference and Academic Period Reference.


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

Wrapper element for Student Period Record Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria [Choice]   Student_Period_Record_Student_Additional_Data_Request_Criteria  [1..1]  Utilize the following criteria options to search for Anticipated Payment Display Rules within the Workday system.   
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_Additional_Data_for_Student_and_Academic_Period_Response

Wrapper element for the Student Period Record information returned as a result of a Get Student Period Records Student Additional Data request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Student_Period_Record_Student_Additional_Data_Request_Criteria  [0..1]  Utilize the following criteria options to search for Anticipated Payment Display Rules within the Workday system.   
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_Period_Record_Student_Additional_Data  [0..1]  Container element for the Student Period Record and the Student Additional Data   
top
 

Student_Period_Record_Student_Additional_Data_Request_Criteria

part of: Get_Student_Additional_Data_for_Student_and_Academic_Period_Response, Get_Student_Additional_Data_for_Student_and_Academic_Period_Request
Utilize the following criteria options to search for Anticipated Payment Display Rules within the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  Student Reference   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period Reference   
top
 

StudentObject

part of: Student_Period_Record_Student_Additional_Data_Request_Criteria, 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_Request_Criteria, 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
 

Response_Filter

part of: Get_Student_Additional_Data_for_Student_and_Academic_Period_Response, Get_Student_Additional_Data_for_Student_and_Academic_Period_Request
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_Additional_Data_for_Student_and_Academic_Period_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_Period_Record_Student_Additional_Data

part of: Get_Student_Additional_Data_for_Student_and_Academic_Period_Response
Container element for the Student Period Record and the Student Additional Data
 
Parameter name Type/Value Cardinality Description Validations
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.   
 
top
 

Student_Period_Record_Student_Additional_Data_Data

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

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
 

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