Service Directory > v31.2 > Financial_Aid > Get_Financial_Aid_Notes
 

Operation: Get_Financial_Aid_Notes

Retrieves Financial Aid notes


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

Get Student Financial Aid Notes Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Financial_Aid_Note_Request_References  [0..1]  Student Financial Aid Note Request Referencesz   
Request_Criteria [Choice]   Financial_Aid_Note_Request_Criteria  [0..1]  Student Financial Aid Note Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Financial_Aid_Note_Response_Group  [0..1]  Student Financial Aid Note Response Group   
top
 

Response Element: Get_Financial_Aid_Notes_Response

Get Student Financial Aid Notes Responsez
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Financial_Aid_Note_Request_References  [0..1]  Student Financial Aid Note Request References   
Request_Criteria  Financial_Aid_Note_Request_Criteria  [0..1]  Student Financial Aid Note Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Financial_Aid_Note_Response_Group  [0..1]  Student Financial Aid Note Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Financial_Aid_Note_Response_Data  [0..1]  Student Financial Aid Note Response Data   
top
 

Financial_Aid_Note_Request_References

part of: Get_Financial_Aid_Notes_Request, Get_Financial_Aid_Notes_Response
Student Financial Aid Note Request References
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Note_Reference  Student_Financial_Aid_NoteObject  [1..*]  Student Financial Aid Note Request References   
top
 

Student_Financial_Aid_NoteObject

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

Student_Financial_Aid_NoteObjectID

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

part of: Get_Financial_Aid_Notes_Request, Get_Financial_Aid_Notes_Response
Student Financial Aid Note Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..*]  When specified, the Get Financial Aid Note task will return Financial Aid Notes for the Students provided   
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [0..*]  When specified, the Get Financial Aid Note task will return Financial Aid Notes with the Financial Aid Award Year given   
Academic_Period_Reference  Academic_PeriodObject  [0..*]  When specified, the Get Financial Aid Note task will return Financial Aid Notes with the Academic Period given   
top
 

StudentObject

part of: Financial_Aid_Note_Request_Criteria, Financial_Aid_Note_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_Award_YearObject

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

Financial_Aid_Award_YearObjectID

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

Financial_Aid_Note_Response_Group

part of: Get_Financial_Aid_Notes_Request, Get_Financial_Aid_Notes_Response
Student Financial Aid Note Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Financial_Aid_Note_Response_Data

part of: Get_Financial_Aid_Notes_Response
Get Student Financial Aid Notes Response
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Note  Financial_Aid_Note  [0..*]  Student Financial Aid Note   
top
 

Financial_Aid_Note

part of: Financial_Aid_Note_Response_Data
Student Financial Aid Note Response Data
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Note_Reference  Student_Financial_Aid_NoteObject  [0..1]  Student Financial Aid Note Reference   
Financial_Aid_Note_Data  Financial_Aid_Note_Data  [0..*]  Student Financial Aid Note Data 
Validation Description
Financial Aid Notes cannot be Public   
Financial Aid Award Year cannot be edited for Financial Aid Note   
The Academic Period must be valid for the selected Student's Attendance Plan.   
Academic Periods can only be submitted if a Student has an Attendance Plan   
 
top
 

Financial_Aid_Note_Data

part of: Financial_Aid_Note
Student Financial Aid Note Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Student_Reference  StudentObject  [1..1]  The Student for this Financial Aid Note 
Validation Description
The Student cannot be edited on a Student Financial Aid Note.   
 
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [1..1]  The Academic Year   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Academic Period valid for the Student's Attendance Plan   
Student_Note_Data  Student_Note_Data  [1..1]  Student Note Data   
Validation Description
Financial Aid Notes cannot be Public   
Financial Aid Award Year cannot be edited for Financial Aid Note   
The Academic Period must be valid for the selected Student's Attendance Plan.   
Academic Periods can only be submitted if a Student has an Attendance Plan   
top
 

Student_Note_Data

part of: Financial_Aid_Note_Data
Student Note Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Note_Topic_Reference  Student_Note_Topic__Mixed_Object  [0..*]  Engagement Conversation Topic Reference   
Student_Note_Type_Reference  Student_Note_TypeObject  [0..1]  Student Note Type Reference   
Student_Note_Date  dateTime  [1..1]  Student Note Date   
Public  boolean  [0..1]  Public   
Note  RichText  [1..1]  The content for the Student Note   
top
 

Student_Note_Topic__Mixed_Object

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

Student_Note_Topic__Mixed_ObjectID

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

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

Student_Note_TypeObjectID

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

Student_Financial_Aid_NoteReferenceEnumeration

part of: Student_Financial_Aid_NoteObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Financial_Aid_Award_YearReferenceEnumeration

part of: Financial_Aid_Award_YearObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Student_Note_Topic__Mixed_ReferenceEnumeration

part of: Student_Note_Topic__Mixed_ObjectID
Base Type
string
top
 

Student_Note_TypeReferenceEnumeration

part of: Student_Note_TypeObjectID
Base Type
string
top
 

RichText

part of: Student_Note_Data
Base Type
string
top