Service Directory > v32.1 > Financial_Aid > Get_Programs_of_Study_for_Enrollment
 

Operation: Get_Programs_of_Study_for_Enrollment

Retrieves the Programs of Study used for Enrollment for an input Financial Aid Record.


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

Wrapper element for Get Programs of Study for Enrollment Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Programs_of_Study_for_Enrollment_Request_References  [1..1]  Wrapper element for Programs of Study for Enrollment Request References   
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_Programs_of_Study_for_Enrollment_Response

Wrapper element for Get Programs of Study for Enrollment Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Programs_of_Study_for_Enrollment_Request_References  [0..1]  Wrapper element for Programs of Study for Enrollment Request References   
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  Programs_of_Study_for_Enrollment_Response_Data  [0..1]  Wrapper element for Programs of Study for Enrollment Response Data   
top
 

Programs_of_Study_for_Enrollment_Request_References

part of: Get_Programs_of_Study_for_Enrollment_Request, Get_Programs_of_Study_for_Enrollment_Response
Wrapper element for Programs of Study for Enrollment Request References
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Record_Reference  Financial_Aid_RecordObject  [1..1]  Financial Aid Record to process   
top
 

Financial_Aid_RecordObject

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

Financial_Aid_RecordObjectID

part of: Financial_Aid_RecordObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Financial_Aid_Record_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Programs_of_Study_for_Enrollment_Request, Get_Programs_of_Study_for_Enrollment_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_Programs_of_Study_for_Enrollment_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
 

Programs_of_Study_for_Enrollment_Response_Data

part of: Get_Programs_of_Study_for_Enrollment_Response
Wrapper element for Programs of Study for Enrollment Response Data
 
Parameter name Type/Value Cardinality Description Validations
Programs_of_Study_for_Enrollment  Programs_of_Study_for_Enrollment  [0..*]  Wrapper element for Programs of Study for Enrollment   
top
 

Programs_of_Study_for_Enrollment

part of: Programs_of_Study_for_Enrollment_Response_Data
Wrapper element for Programs of Study for Enrollment
 
Parameter name Type/Value Cardinality Description Validations
Financial_Aid_Record_Reference  Financial_Aid_RecordObject  [0..1]  Financial Aid Record to process   
Programs_of_Study_for_Enrollment_Data  Programs_of_Study_for_Enrollment_Data  [0..*]  Wrapper element for Programs of Study for Enrollment Data   
top
 

Programs_of_Study_for_Enrollment_Data

part of: Programs_of_Study_for_Enrollment
Wrapper element for Programs of Study for Enrollment Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Financial Aid Record   
Programs_of_Study_for_Enrollment_Effective_Date_Data  Programs_of_Study_for_Enrollment_Effective_Date_Data  [0..*]  Wrapper element for Programs of Study for Enrollment Effective Date Data 
Validation Description
The Primary Program of Study of the Reporting Record, as of the effective date, must be selected if the program of study status is one of the following: Pending Completion, In Progress, or Matriculated  The Primary Program of Study of the Reporting Record, as of the effective date, must be selected if the program of study status is one of the following: Pending Completion, In Progress, or Matriculated 
There is no program of study or record change for the effective date  There is no program of study or record change for the effective date 
You must use the Edit Program of Study for Load Status task to delete financial aid record snapshots without a corresponding program of study change for the students listed here. To preserve the Academic Requirements Used setting, update a previous or later snapshot to reflect the configuration. To preserve the Reporting Record change, contact your records administrator to update a previous or later snapshot.   
 
top
 

Programs_of_Study_for_Enrollment_Effective_Date_Data

part of: Programs_of_Study_for_Enrollment_Data
Wrapper element for Programs of Study for Enrollment Effective Date Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Effective Date for Programs of Study for Enrollment Snapshot   
Programs_of_Study_for_Enrollment_Program_Data  Programs_of_Study_for_Enrollment_Program_Data  [0..*]  Wrapper element for Programs of Study for Enrollment Program Data 
Validation Description
The Program of Study cannot be selected if it is not Title IV eligible as of the effective date, unless it is the Primary Program of Study for the Reporting Record  The Program of Study cannot be selected if it is not Title IV eligible as of the effective date, unless it is the Primary Program of Study for the Reporting Record 
The Program of Study can only be selected if the program of study status is one of the following: Pending Completion, In Progress, or Matriculated  The Program of Study can only be selected if the program of study status is one of the following: Pending Completion, In Progress, or Matriculated 
 
Validation Description
The Primary Program of Study of the Reporting Record, as of the effective date, must be selected if the program of study status is one of the following: Pending Completion, In Progress, or Matriculated  The Primary Program of Study of the Reporting Record, as of the effective date, must be selected if the program of study status is one of the following: Pending Completion, In Progress, or Matriculated 
There is no program of study or record change for the effective date  There is no program of study or record change for the effective date 
You must use the Edit Program of Study for Load Status task to delete financial aid record snapshots without a corresponding program of study change for the students listed here. To preserve the Academic Requirements Used setting, update a previous or later snapshot to reflect the configuration. To preserve the Reporting Record change, contact your records administrator to update a previous or later snapshot.   
top
 

Programs_of_Study_for_Enrollment_Program_Data

part of: Programs_of_Study_for_Enrollment_Effective_Date_Data
Wrapper element for Programs of Study for Enrollment Program Data
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference  Program_of_StudyObject  [1..1]  Program of Study for the Financial Aid Record Snapshot   
Academic_Requirements_Used  boolean  [0..1]  Whether the Academic Requirements for the Program of Study are used to determine the Load Status for the Student as of the Snapshot date   
Validation Description
The Program of Study cannot be selected if it is not Title IV eligible as of the effective date, unless it is the Primary Program of Study for the Reporting Record  The Program of Study cannot be selected if it is not Title IV eligible as of the effective date, unless it is the Primary Program of Study for the Reporting Record 
The Program of Study can only be selected if the program of study status is one of the following: Pending Completion, In Progress, or Matriculated  The Program of Study can only be selected if the program of study status is one of the following: Pending Completion, In Progress, or Matriculated 
top
 

Program_of_StudyObject

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

Program_of_StudyObjectID

part of: Program_of_StudyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Program_of_Study_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Financial_Aid_RecordReferenceEnumeration

part of: Financial_Aid_RecordObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top