Service Directory > v31.2 > 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.   
If the Student Award Item is not considered Anticipated Aid, then Anticipated Payment Display Rule cannot be set.   
The Award Sort has a maximum length of four and can only contain lowercase letters.   
If the Student Award Type is Work-Study, you must provide a Student Work-Study Allocation reference.   
A Student Work-Study Allocation cannot be entered unless the Student Award Type is Work-Study.   
The selected Disbursement Proration Rule must be configured for the Institution of the selected Academic Unit   
The Academic Unit cannot be changed for this Student Award Item.   
The Academic Level cannot be changed for this Student Award Item.   
Select an Academic Unit and Academic Level for Work-Study Allocation that matches the values you chose for Student Award Item. You can also select a more granular Academic Unit.   
You cannot submit a student award item with multiple award limits for the same frequency.   
A Work-Study Payment Condition cannot be entered unless the Student Award Type is Work-Study.   
Change the Currency to match the default currency for the student's academic unit: [currency]   
Academic Period (POS) Load Status or Course Start (POS) Load Status can only be provided if Load Status is a Work-Study Payment Condition.   
You must select a Work-Study Load Status of Academic Period (POS) or Course Start (POS) and it's corresponding value.   
Student Award Item cannot have both an Academic Period (POS) Load Status and a Course Start (POS) Load Status.   
If the federal program ID is a PLUS or graduate PLUS loan, enter Provisional for initial award status.   
Worktag Balancing is enabled for this AU and therefore a default value for the Primary Worktag Balancing Type [fund] must be selected.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have an Aggregate Limit.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have a Frequency of Award.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot be Packaged Once.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have Fiscal Limits.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have an Award Eligibility Calculation.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have an Amount Calculation.   
Spend Category is Required, if Disbursable is true.   
Enter a company and grant combination that matches the company on the award line.   
 
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.   
Has_Academic_Curricular_Division_Data  Has_Academic_Curricular_Division_Data  [1..*]  Academic Curricular Division Data. 
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
 
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.   
Inactive  boolean  [0..1]  Student Award Item Inactive   
Currency_Reference  CurrencyObject  [0..1]  Student Award Item Currency   
Type_Reference  Student_Award_TypeObject  [1..1]  Student Award Item Student Award Type   
Loan_Fee_Reference  Loan_FeeObject  [0..1]  Student Award Item Loan Fee 
Validation Description
Loan Fee is valid only if the Award Type is Loan.   
If the Student Award Type of this Student Award Item is not Loan, then Loan Fee cannot be set.   
 
Loan_Fee_Deduction_Method_Reference  Loan_Fee_Deduction_MethodObject  [0..1]  Student Award Item Loan Fee Deduction Method 
Validation Description
Loan Fee Deduction Method is valid only if the Award Type is Loan.   
If the Student Award Type of this Student Award Item is not Loan, then Loan Fee Deduction Method cannot be set.   
If Loan Fee is set on this Student Award Item, then the Loan Fee Deduction Method is required.   
 
Source_Reference  Student_Award_SourceObject  [1..1]  Student Award Item Student Award Source   
Spend_Category_Reference  Spend_CategoryObject  [0..1]  Spend Category   
Student_Award_Item_Related_Worktags  Related_Worktag_Widget_Data  [0..1]  Student Award Item Related Worktags 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
 
Need_Method_Reference  Student_Award_Need_MethodObject  [1..1]  Student Award Item Need Method   
Federal_Program_ID_Reference  Student_Award_Federal_Program_IDObject  [0..1]  Student Award Item Federal Program ID   
IPEDS_Mapping_Reference  Student_Award_IPEDS_MappingObject  [0..1]  Student Award Item IPEDS Mapping   
Student_Award_Status_Reference  Student_Award_StatusObject  [0..1]  The System Award Status for a Student Award Item.   
Student_Allowable_Action_Reference  Student_Allowable_ActionObject  [0..*]  Student Award Item Allowable Action 
Validation Description
If Amount Calculation is set on this Student Award Item, then Student Allowable Action is required.   
 
No_Rounding  boolean  [0..1]  Student Award Item No Rounding   
Package_Once  boolean  [0..1]  Student Award Item Lock   
Award_Sort  string  [0..1]  Student Award Item Sort Order   
Manual_Override  boolean  [0..1]  Student Award Item Manual Override   
Engagement_Action_Item_Reference  Financial_Aid_Action_ItemObject  [0..*]  Student Award Item Requirements 
Validation Description
Please select an Action Item for Award Item that is of type Completed via Integration and a supported Completion Criteria   
 
Award_Eligibility_Calculation_Reference  CalculationObject  [0..1]  Student Award Item Eligibility Calculation 
Validation Description
The calculation used for the Student Award Eligibility calculation must be a boolean calculation.   
 
Amount_Calculation_Reference  CalculationObject  [0..1]  Student Award Item Amount Calculation 
Validation Description
The calculation used for Student Award Item Amount Calculation must be a numeric calculation.   
 
Frequency_of_Award_Amount_Reference  Frequency_of_Award_AmountObject  [0..1]  Student Award Item Frequency of Award Amount 
Validation Description
If Amount Calculation is set on this Student Award Item, then Frequency of Award Amount is required.   
 
Student_Award_Item_Limit_Data_Reference  Student_Award_Item_Limit_Data  [0..*]  Data element containing Aggregate Limit information for a Student Award Item 
Validation Description
The minimum amount must be less than or equal to the maximum amount.   
Limits on Lifetime Amount or the Number of Academic Periods awarded cannot have a non-zero minimum.   
Please specify the frequency for your student award limit item.   
 
Fiscal_Limit_Reference  Fiscal_LimitObject  [0..*]  Student Award Item Fiscal Limit   
Disbursable  boolean  [0..1]  Student Award Item Disbursable   
Disbursement_Eligibility_Condition_Reference  Eligibility_ConditionObject  [0..*]  The Disbursement Eligibility Conditions that must be met by the student before funds are disbursed 
Validation Description
Invalid Disbursement Eligibility Condition provided.   
 
Disbursement_Eligibility_Calculation_Reference  CalculationObject  [0..1]  Student Award Item Disbursement Eligibility Calculation 
Validation Description
The calculation used for the Student Award Item Disbursement Eligibility Calculation must be a boolean calculation.   
If Student Payment Source Disbursable is false, then Disbursement Eligibility Calculation cannot be set.   
 
Disbursement_Schedule_Rule_Reference  Student_Disbursement_Schedule_RuleObject  [0..1]  Student Award Item Reusable Schedule Definition   
Disbursement_Proration_Rule_Reference  Disbursement_Proration_RuleObject  [0..1]  Student Award Item Disbursement Proration Rule   
Include_All_Enrollment  boolean  [0..1]  Indicates whether all Enrollments are included when establishing the Load Status for an Academic Period   
Work_Study_Payment_Condition_Reference  Eligibility_ConditionObject  [0..*]  Student must meet the Work-Study eligibility condition(s) that are set by the school before making the student eligible for Work-Study. 
Validation Description
Invalid Work-Study Payment Condition provided   
 
Academic_Period_POS_Load_Status_Reference  Student_Load_StatusObject  [0..1]  Academic Period (POS): If selected, evaluates the load status from the Academic Period (POS) on the Attendance Plan to determine if the student is Work-Study eligible. 
Validation Description
Invalid Load Status provided.   
 
Course_Start_POS_Load_Status_Reference  Student_Load_StatusObject  [0..1]  Course Start (POS): If selected, evaluates the load status from the Course Start (POS) on the Attendance Plan to determine if the student is Work-Study eligible. 
Validation Description
Invalid Load Status provided.   
 
Refundable  boolean  [0..1]  Student Award Item Refundable   
Anticipated_Aid  boolean  [0..1]  Student Award Item Anticipated AId   
Anticipated_Payment_Display_Rule_Reference  Anticipated_Payment_Display_RuleObject  [0..1]  Student Award Item Anticipated Payment Display Rule   
Student_Precedence_Group_Reference  Student_Precedence_GroupObject  [0..1]  Student Award Item Student Precedence Group 
Validation Description
If Student Payment Source Disbursable is true, then Precedence Group is required.   
 
Student_Work_Study_Allocation_Reference  Student_Work_Study_AllocationObject  [0..1]  Student Work Study Allocation Reference. Required when the Student Award Type is Work Study.   
Validation Description
A unique Student Award Item name is required.   
If the Student Award Item is not considered Anticipated Aid, then Anticipated Payment Display Rule cannot be set.   
The Award Sort has a maximum length of four and can only contain lowercase letters.   
If the Student Award Type is Work-Study, you must provide a Student Work-Study Allocation reference.   
A Student Work-Study Allocation cannot be entered unless the Student Award Type is Work-Study.   
The selected Disbursement Proration Rule must be configured for the Institution of the selected Academic Unit   
The Academic Unit cannot be changed for this Student Award Item.   
The Academic Level cannot be changed for this Student Award Item.   
Select an Academic Unit and Academic Level for Work-Study Allocation that matches the values you chose for Student Award Item. You can also select a more granular Academic Unit.   
You cannot submit a student award item with multiple award limits for the same frequency.   
A Work-Study Payment Condition cannot be entered unless the Student Award Type is Work-Study.   
Change the Currency to match the default currency for the student's academic unit: [currency]   
Academic Period (POS) Load Status or Course Start (POS) Load Status can only be provided if Load Status is a Work-Study Payment Condition.   
You must select a Work-Study Load Status of Academic Period (POS) or Course Start (POS) and it's corresponding value.   
Student Award Item cannot have both an Academic Period (POS) Load Status and a Course Start (POS) Load Status.   
If the federal program ID is a PLUS or graduate PLUS loan, enter Provisional for initial award status.   
Worktag Balancing is enabled for this AU and therefore a default value for the Primary Worktag Balancing Type [fund] must be selected.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have an Aggregate Limit.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have a Frequency of Award.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot be Packaged Once.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have Fiscal Limits.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have an Award Eligibility Calculation.   
An Award Item that contains Federal Program ID values of PLUS or Grad PLUS Loan cannot have an Amount Calculation.   
Spend Category is Required, if Disbursable is true.   
Enter a company and grant combination that matches the company on the award line.   
top
 

Has_Academic_Curricular_Division_Data

part of: Student_Award_Item_Data
Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level Nonsingular Workset   
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_Curricular_DivisionObject

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

Academic_Curricular_DivisionObjectID

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

CurrencyObject

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

CurrencyObjectID

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

Loan_FeeObject

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

Loan_FeeObjectID

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

Loan_Fee_Deduction_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  Loan_Fee_Deduction_MethodObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Loan_Fee_Deduction_MethodObjectID

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

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Related_Worktag_Widget_Data

part of: Student_Award_Item_Data
Reference to the existing Allowed or Default Related Worktags.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  All existing related worktags (both allowed and default) are replaced with the ones specified in the request. It will supersede any "remove all" or delete option set to True by worktag type. When True, a default value must be provided for all worktag types that are configured with 'Default Required' in the 'Maintain Related Worktag Usage'.   
Related_Worktags_by_Type_Data  Related_Worktags_by_Worktag_Type_Data  [0..*]  Allowed and Default Related Worktags Data by Worktag Type. 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
top
 

Related_Worktags_by_Worktag_Type_Data

part of: Related_Worktag_Widget_Data
Allowed and Default Related Worktags Data by Worktag Type.
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..1]  The Worktag Type Reference ID cannot be duplicated within one request. Valid ID types for all worktag types that can be configured for a related worktag taggable type may include: BUSINESS_SITE, BUSINESS_UNIT, COST_CENTER, CUSTOM_ORGANIZATION_01-10, CUSTOM_WORKTAG_1-10, FUND, GIFT, GRANT, INVESTOR, OPPORTUNITY, PROGRAM, PROJECT, PROJECT_PHASE, PROJECT_TASK, REGION, SALES_ITEM.   
Required_On_Transaction  boolean  [0..1]  Boolean to indicate if the Worktag Type will be required on a transaction when a value for the worktag type that has related values is entered.   
Required_On_Transaction_For_Validation  boolean  [0..1]  Boolean to indicate if 'Required on Transaction' is enabled in either 'Maintain Related Worktag Usage' or on the Worktag instance. When you generate an EIB template with data, 'y' is returned when either boolean is true. This boolean is informational only in the 'Put' operation.   
Default_Worktag_Data  Default_Worktag_Data  [0..1]  Reference to existing Default Realted Worktag or Add new Default Related Worktag 
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Replace_All_Allowed_Values  boolean  [0..1]  Boolean to indicate that all existing allowed values are to be deleted. When set to true ('y' in EIB), if allowed values are also specified, they will become the new set of allowed values.   
Allowed_Worktag_Data  Allowed_Worktag_Data  [0..*]  Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags 
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
top
 

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

Default_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Default Realted Worktag or Add new Default Related Worktag
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Default_Value  boolean  [1..1]  Boolean to indicate if existing default value is to be deleted. The existing default value must be correctly specified. Do not set to true (or 'y' in EIB) to replace the existing default value.   
Default_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

Accounting_Worktag_and_Aggregation_DimensionObject

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

Accounting_Worktag_and_Aggregation_DimensionObjectID

part of: Accounting_Worktag_and_Aggregation_DimensionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_Hierarchy_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_Group_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_Group_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_Hierarchy_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Family_Group_ID, Job_Family_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_Hierarchy_ID, Program_ID, Program_of_Study_ID, Project_Hierarchy_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_Group_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Resource_Category_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_Group_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Sponsor_Type_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_Group_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Allowed_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Allowed_Value  boolean  [1..1]  Boolean to indicate that specified allowed values are to be deleted. At least 1 existing allowed value must be specified When set to true (or 'y' in EIB). Cannot be set to true if 'Replace All Allowed Values' is set to true.   
Allowed_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_Hierarchy_ID, Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_Hierarchy_ID, Fund_ID, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_Hierarchy_ID, Program_ID, Project_Hierarchy_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
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_Federal_Program_IDObject

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

Student_Award_Federal_Program_IDObjectID

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

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

Student_Award_IPEDS_MappingObjectID

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

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

Student_Award_StatusObjectID

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

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

Student_Allowable_ActionObjectID

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

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

Financial_Aid_Action_ItemObjectID

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

CalculationObject

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

CalculationObjectID

part of: CalculationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Balance_ID, Absence_Component_Related_Calculation_ID, Absence_Plan_ID, Accrual_Code, Aggregate_Calculation_ID, Arithmetic_Calculation_ID, Build_Date_Calculation_ID, Calculation_Compensation_Basis_ID, Compensation_Basis_ID, Compensation_Plan_ID, Conditional_Calculation_ID, Constant_Date_Calculation_ID, Constant_Value_Calculation_ID, Date_Difference_Calculation_ID, Date_Extract_Calculation_ID, Date_Increment_Decrement_Calculation_ID, Deduction_Code, Earning_Code, Instance_Set_Comparison_Calculation, Instance_Value_Calculation_ID, Logic_Calculation_ID, Lookup_Calculation_ID, Pay_Accumulation_Code, Pay_Balance_Code, Pay_Component_Group_Code, Pay_Component_Related_Calculation_Code, Related_Calculation_ID, Time_Off_Code, Value_Comparison_Calculation_ID, Workday_Absence_Balance_ID, Workday_Absence_Code, Workday_Absence_Component_Related_Calculation_ID, Workday_Absence_Plan_ID, Workday_Accrual_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Accumulation_Code, Workday_Pay_Balance_Code, Workday_Pay_Component_Group_Code, Workday_Pay_Component_Related_Calculation_Code, Workday_Related_Calculation_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
 

Frequency_of_Award_AmountObject

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

Frequency_of_Award_AmountObjectID

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

part of: Student_Award_Item_Data
Data element containing Aggregate Limit information for Student Award Items
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Student Award Item Limit Reference   
Student_Aggregate_Limit_Type_Reference  Student_Aggregate_Limit_TypeObject  [0..1]  Student Aggregate Limit Type Reference   
Minimum  decimal (11, 2) >0   [0..1]  Student Award Item Limit Minimum   
Maximum  decimal (11, 2) >0   [0..1]  Student Award Item Limit Maximum   
Validation Description
The minimum amount must be less than or equal to the maximum amount.   
Limits on Lifetime Amount or the Number of Academic Periods awarded cannot have a non-zero minimum.   
Please specify the frequency for your student award limit item.   
top
 

Student_Aggregate_Limit_TypeObject

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

Student_Aggregate_Limit_TypeObjectID

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

Fiscal_LimitObject

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

Fiscal_LimitObjectID

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

Eligibility_ConditionObject

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

Eligibility_ConditionObjectID

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

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

Student_Disbursement_Schedule_RuleObjectID

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

Disbursement_Proration_RuleObject

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

Disbursement_Proration_RuleObjectID

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

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

Anticipated_Payment_Display_RuleObject

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

Anticipated_Payment_Display_RuleObjectID

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

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

Student_Precedence_GroupObjectID

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

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

Student_Work_Study_AllocationObjectID

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

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Student_Award_TypeReferenceEnumeration

part of: Student_Award_TypeObjectID
Base Type
string
top
 

Loan_FeeReferenceEnumeration

part of: Loan_FeeObjectID
Base Type
string
top
 

Loan_Fee_Deduction_MethodReferenceEnumeration

part of: Loan_Fee_Deduction_MethodObjectID
Base Type
string
top
 

Student_Award_SourceReferenceEnumeration

part of: Student_Award_SourceObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_and_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_and_Aggregation_DimensionObjectID
Base Type
string
top
 

Student_Award_Need_MethodReferenceEnumeration

part of: Student_Award_Need_MethodObjectID
Base Type
string
top
 

Student_Award_Federal_Program_IDReferenceEnumeration

part of: Student_Award_Federal_Program_IDObjectID
Base Type
string
top
 

Student_Award_IPEDS_MappingReferenceEnumeration

part of: Student_Award_IPEDS_MappingObjectID
Base Type
string
top
 

Student_Award_StatusReferenceEnumeration

part of: Student_Award_StatusObjectID
Base Type
string
top
 

Student_Allowable_ActionReferenceEnumeration

part of: Student_Allowable_ActionObjectID
Base Type
string
top
 

Financial_Aid_Action_ItemReferenceEnumeration

part of: Financial_Aid_Action_ItemObjectID
Base Type
string
top
 

CalculationReferenceEnumeration

part of: CalculationObjectID
Base Type
string
top
 

Frequency_of_Award_AmountReferenceEnumeration

part of: Frequency_of_Award_AmountObjectID
Base Type
string
top
 

Student_Aggregate_Limit_TypeReferenceEnumeration

part of: Student_Aggregate_Limit_TypeObjectID
Base Type
string
top
 

Fiscal_LimitReferenceEnumeration

part of: Fiscal_LimitObjectID
Base Type
string
top
 

Eligibility_ConditionReferenceEnumeration

part of: Eligibility_ConditionObjectID
Base Type
string
top
 

Student_Disbursement_Schedule_RuleReferenceEnumeration

part of: Student_Disbursement_Schedule_RuleObjectID
Base Type
string
top
 

Disbursement_Proration_RuleReferenceEnumeration

part of: Disbursement_Proration_RuleObjectID
Base Type
string
top
 

Student_Load_StatusReferenceEnumeration

part of: Student_Load_StatusObjectID
Base Type
string
top
 

Anticipated_Payment_Display_RuleReferenceEnumeration

part of: Anticipated_Payment_Display_RuleObjectID
Base Type
string
top
 

Student_Precedence_GroupReferenceEnumeration

part of: Student_Precedence_GroupObjectID
Base Type
string
top
 

Student_Work_Study_AllocationReferenceEnumeration

part of: Student_Work_Study_AllocationObjectID
Base Type
string
top