Service Directory > v32.1 > Financial_Aid > Get_Load_Status_Overrides_for_Financial_Aid_Period_Records
 

Operation: Get_Load_Status_Overrides_for_Financial_Aid_Period_Records

Returns the load status overrides for Financial Aid Period Records specified by Reference ID, or specified by student, academic period, academic unit, academic level, or program of study. If the request does not specify a Financial Aid Period Record or criteria, this operation returns information for all Financial Aid Period Records.


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

Element container for Get Load Status Overrides for Financial Aid Period Records Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Load_Status_Overrides_for_Financial_Aid_Period_Record_Request_References  [0..1]  Element container for Load Status Overrides for Financial Aid Period Record Request References   
Request_Criteria [Choice]   Load_Status_Overrides_for_Financial_Aid_Period_Record_Request_Criteria  [0..1]  Element container for Load Status Overrides for Financial Aid Period Record Request Criteria   
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_Load_Status_Overrides_for_Financial_Aid_Period_Records_Response

Element container for Get Load Status Overrides for Financial Aid Period Records Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Load_Status_Overrides_for_Financial_Aid_Period_Record_Request_References  [0..1]  Element container for Load Status Overrides for Financial Aid Period Record Request References   
Request_Criteria  Load_Status_Overrides_for_Financial_Aid_Period_Record_Request_Criteria  [0..1]  Element container for Load Status Overrides for Financial Aid Period Record Request Criteria   
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  Load_Status_Overrides_for_Financial_Aid_Period_Record_Response_Data  [0..1]  Element container for Load Status Overrides for Financial Aid Period Record Response Data   
top
 

Load_Status_Overrides_for_Financial_Aid_Period_Record_Request_References

part of: Get_Load_Status_Overrides_for_Financial_Aid_Period_Records_Response, Get_Load_Status_Overrides_for_Financial_Aid_Period_Records_Request
Element container for Load Status Overrides for Financial Aid Period Record Request References
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Period_Record_Reference  Financial_Aid_Period_RecordObject  [1..*]  Financial Aid Period Record Reference   
top
 

Financial_Aid_Period_RecordObject

part of: Load_Status_Overrides_for_Financial_Aid_Period_Record__HV__Data, Load_Status_Overrides_for_Financial_Aid_Period_Record_Request_References, Load_Status_Overrides_for_Financial_Aid_Period_Record
 
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_Period_RecordObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Financial_Aid_Period_RecordObjectID

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

Load_Status_Overrides_for_Financial_Aid_Period_Record_Request_Criteria

part of: Get_Load_Status_Overrides_for_Financial_Aid_Period_Records_Response, Get_Load_Status_Overrides_for_Financial_Aid_Period_Records_Request
Element container for Load Status Overrides for Financial Aid Period Record Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..*]  Student Reference   
Academic_Period_Reference  Academic_PeriodObject  [0..*]  Academic Period Reference   
Academic_Unit_Reference  Academic_UnitObject  [0..*]  Academic Unit Reference   
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level Reference   
Program_of_Study_Reference  Program_of_StudyObject  [0..*]  Program of Study Reference   
top
 

StudentObject

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

Academic_UnitObject

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

Academic_LevelObject

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

Academic_LevelObjectID

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

Program_of_StudyObject

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

Program_of_StudyObjectID

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

Load_Status_Overrides_for_Financial_Aid_Period_Record_Response_Data

part of: Get_Load_Status_Overrides_for_Financial_Aid_Period_Records_Response
Element container for Load Status Overrides for Financial Aid Period Record Response Data
 
Parameter name Type/Value Cardinality Description Validations
Load_Status_Overrides_for_Financial_Aid_Period_Record  Load_Status_Overrides_for_Financial_Aid_Period_Record  [0..*]  Element container for Load Status Overrides for Financial Aid Period Record   
top
 

Load_Status_Overrides_for_Financial_Aid_Period_Record

part of: Load_Status_Overrides_for_Financial_Aid_Period_Record_Response_Data
Element container for Load Status Overrides for Financial Aid Period Record
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Period_Record_Reference  Financial_Aid_Period_RecordObject  [0..1]  Financial Aid Period Record Reference   
Load_Status_Overrides_for_Financial_Aid_Period_Record_Data  Load_Status_Overrides_for_Financial_Aid_Period_Record__HV__Data  [0..*]  Container element for the Load Status Overrides for a Financial Aid Period Record 
Validation Description
No Overridden Load Status can have a value of Part-time.   
 
top
 

Load_Status_Overrides_for_Financial_Aid_Period_Record__HV__Data

part of: Load_Status_Overrides_for_Financial_Aid_Period_Record
Container element for the Load Status Overrides for a Financial Aid Period Record
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Period_Record_Reference  Financial_Aid_Period_RecordObject  [1..1]  Financial Aid Period Record Reference   
Projected_Load_Status_Override_Reference  Student_Load_StatusObject  [0..1]  Projected Load Status Override Reference   
Academic_Period_All_Enrollments_Load_Status_Override_Reference  Student_Load_StatusObject  [0..1]  Academic Period All Enrollments Load Status Override Reference   
Academic_Period_Program_Enrollments_Load_Status_Override_Reference  Student_Load_StatusObject  [0..1]  Academic Period Program Enrollments Load Status Override Reference   
Course_Start_All_Enrollments_Load_Status_Override_Reference  Student_Load_StatusObject  [0..1]  Course Start All Enrollments Override Reference   
Course_Start_Program_Enrollments_Load_Status_Override_Reference  Student_Load_StatusObject  [0..1]  Course Start Program Enrollments Override Reference   
Verified_Participation_All_Enrollments_Load_Status_Override_Reference  Student_Load_StatusObject  [0..1]  Attendance Verified All Enrollments Override Reference   
Verified_Participation_Program_Enrollments_Load_Status_Override_Reference  Student_Load_StatusObject  [0..1]  Attendance Verified Program Enrollments Override Reference   
Validation Description
No Overridden Load Status can have a value of Part-time.   
top
 

Student_Load_StatusObject

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

Student_Load_StatusObjectID

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

Financial_Aid_Period_RecordReferenceEnumeration

part of: Financial_Aid_Period_RecordObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

Student_Load_StatusReferenceEnumeration

part of: Student_Load_StatusObjectID
Base Type
string
top