Service Directory > v32.1 > Financial_Aid > Get_Student_Preliminary_Awards
 

Operation: Get_Student_Preliminary_Awards

Returns Student Preliminary Awards by Reference ID, or Academic Period Reference, Academic Person Reference and/or Student Award Item Reference. Returns all Student Preliminary Awards if no Reference ID or criteria is provided.


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

Element Container for Get Student Preliminary Awards Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Preliminary_Award_Request_References  [0..1]  Element Container for Get Student Preliminary Awards Request   
Request_Criteria [Choice]   Student_Preliminary_Award_Request_Criteria  [0..1]  Element Container for Get Student Preliminary Awards Request   
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_Preliminary_Awards_Response

Element Container for Get Student Preliminary Awards Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Preliminary_Award_Request_References  [0..1]  Element Container for Student Preliminary Award Request References   
Request_Criteria  Student_Preliminary_Award_Request_Criteria  [0..1]  Element Container for Student Preliminary Award 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  Student_Preliminary_Award_Response_Data  [0..1]  Element Container for Student Preliminary Award Response Data   
top
 

Student_Preliminary_Award_Request_References

part of: Get_Student_Preliminary_Awards_Request, Get_Student_Preliminary_Awards_Response
Element Container for Student Preliminary Award Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Preliminary_Award_Reference  Student_Preliminary_AwardObject  [1..*]  This Student Preliminary Award   
top
 

Student_Preliminary_AwardObject

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

Student_Preliminary_AwardObjectID

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

part of: Get_Student_Preliminary_Awards_Request, Get_Student_Preliminary_Awards_Response
Element Container for Student Preliminary Award Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..*]  The Student Recruitment that owns the Student Preliminary Award   
Academic_Period_Reference  Academic_Period_AbstractObject  [0..*]  Academic Period for Student Preliminary Award   
Student_Award_Item_Reference  Student_Award_ItemObject  [0..*]  Student Award Item for Student Preliminary Award   
top
 

StudentObject

part of: Student_Preliminary_Award_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_Period_AbstractObject

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

Academic_Period_AbstractObjectID

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

part of: Student_Preliminary_Award_Request_Criteria, Student_Preliminary_Award_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_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
 

Response_Filter

part of: Get_Student_Preliminary_Awards_Request, Get_Student_Preliminary_Awards_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_Preliminary_Awards_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_Preliminary_Award_Response_Data

part of: Get_Student_Preliminary_Awards_Response
Element Container for Student Preliminary Award Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Preliminary_Award  Student_Preliminary_Award  [0..*]  Element Container for Student Preliminary Award   
top
 

Student_Preliminary_Award

part of: Student_Preliminary_Award_Response_Data
Element Container for Student Preliminary Award
 
Parameter name Type/Value Cardinality Description Validations
Student_Preliminary_Award_Reference  Student_Preliminary_AwardObject  [0..1]  This Student Preliminary Award   
Student_Preliminary_Award_Data  Student_Preliminary_Award_Data  [0..*]  Element Container for Student Preliminary Award Data   
top
 

Student_Preliminary_Award_Data

part of: Student_Preliminary_Award
Element Container for Student Preliminary Award Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Preliminary Award   
Student_Prospect_Recruitment_Reference  Student_RecruitmentObject  [0..1]  The Student Recruitment that owns the Student Preliminary Award   
Student_Preliminary_Award_Date  dateTime  [1..1]  Student Preliminary Award Date for Student Preliminary Award.   
Academic_Period_Reference  Academic_Period_AbstractObject  [1..1]  Academic Period for Student Preliminary Award   
Student_Award_Item_Reference  Student_Award_ItemObject  [1..1]  Student Award Item for Student Preliminary Award   
Student_Preliminary_Award_Amount  decimal (14, 2) >0   [1..1]  Student Preliminary Award Amount for Student Preliminary Award   
Student_Preliminary_Official_Award  boolean  [0..1]  Student Preliminary Official Award for Student Preliminary Award   
top
 

Student_RecruitmentObject

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

Student_RecruitmentObjectID

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

part of: Student_Preliminary_AwardObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_Period_AbstractReferenceEnumeration

part of: Academic_Period_AbstractObjectID
Base Type
string
top
 

Student_Award_ItemReferenceEnumeration

part of: Student_Award_ItemObjectID
Base Type
string
top
 

Student_RecruitmentReferenceEnumeration

part of: Student_RecruitmentObjectID
Base Type
string
top