Service Directory > v25.1 > Financial_Aid > Get_Student_Award_Items
 

Operation: Get_Student_Award_Items

Returns information for Student Award Items specified in the request. If the request does not specify a Student Award Item, this operation returns information for all Student Award Items.


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

Wrapper element for Student Award Items Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Award_Item_Request_References  [0..1]  Element containing the list of Student Award Items for which data is requested.   
Request_Criteria [Choice]   Student_Award_Item_Request_Criteria  [0..1]  Utilize the following criteria options to search for Student Award Items 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_Award_Items_Response

Wrapper element for the Student Award Item information returned as a result of a Get Student Award Item Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Award_Item_Request_References  [0..1]  Element containing the list of Student Award Items for which data is requested.   
Request_Criteria  Student_Award_Item_Request_Criteria  [0..1]  Utilize the following criteria options to search for Student Award Items 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_Award_Item_Response_Data  [0..1]  Wrapper Element for the Student Award Item data   
top
 

Student_Award_Item_Request_References

part of: Get_Student_Award_Items_Request, Get_Student_Award_Items_Response
Element containing the list of Student Award Items for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Student_Award_Item_Reference  Student_Award_ItemObject  [1..1]  Element containing the list of Student Award Definitions for which data is requested.   
top
 

Student_Award_ItemObject

part of: Student_Award_Item_Request_References, Student_Award_Item
 
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
 

Student_Award_Item_Request_Criteria

part of: Get_Student_Award_Items_Request, Get_Student_Award_Items_Response
Utilize the following criteria options to search for Student Award Items within the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Effective_as_of_Date  date  [0..1]  Search for a Student Award Item using the Effective as of Date.   
top
 

Response_Filter

part of: Get_Student_Award_Items_Request, Get_Student_Award_Items_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
 

Response_Results

part of: Get_Student_Award_Items_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_Award_Item_Response_Data

part of: Get_Student_Award_Items_Response
Wrapper Element for the Student Award Item data
 
Parameter name Type/Value Cardinality Description Validations
Student_Award_Item  Student_Award_Item  [0..*]  Wrapper element for the Student Charge Item Data   
top
 

Student_Award_Item

part of: Student_Award_Item_Response_Data
Wrapper for Student Award Item Get Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Award_Item_Reference  Student_Award_ItemObject  [0..1]  Student Award Item Reference   
Student_Award_Item_Data  Student_Award_Item_Data  [0..1]  Wrapper element for Student Award Item Data 
Validation Description
A unique Student Award Item name is required.   
 
top
 

Student_Award_Item_Data

part of: Student_Award_Item
Wrapper element for Student Award Item Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Award Item   
Effective_Date  date  [1..1]  Search for a Student Award Item using the Effective as of Date.   
Name  string  [1..1]  Search for a Student Award Item using the Name. The match must be an exact match with a Student Award Item Name that contains the Name specified.   
Type_Reference  Student_Award_TypeObject  [1..1]  Student Award Item Student Award Type   
Source_Reference  Student_Award_SourceObject  [1..1]  Student Award Item Student Award Source   
Need_Method_Reference  Student_Award_Need_MethodObject  [1..1]  Student Award Item Need Method   
Validation Description
A unique Student Award Item name is required.   
top
 

Student_Award_TypeObject

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

Student_Award_TypeObjectID

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

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

Student_Award_SourceObjectID

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

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

Student_Award_Need_MethodObjectID

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

part of: Student_Award_ItemObjectID
Base Type
string
top
 

Student_Award_TypeReferenceEnumeration

part of: Student_Award_TypeObjectID
Base Type
string
top
 

Student_Award_SourceReferenceEnumeration

part of: Student_Award_SourceObjectID
Base Type
string
top
 

Student_Award_Need_MethodReferenceEnumeration

part of: Student_Award_Need_MethodObjectID
Base Type
string
top