Service Directory > v31.2 > Financial_Aid > Put_Programs_of_Study_for_Enrollment
 

Operation: Put_Programs_of_Study_for_Enrollment

Sets the Programs of Studies 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: Put_Programs_of_Study_for_Enrollment_Request

Wrapper element for Put Programs of Study for Enrollment Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
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  [1..1]  Wrapper element for Programs of Study for Enrollment Data   
Validation Description
Either the Financial Aid Record Reference or ID field must be provided.  Either the Financial Aid Record Reference or ID field must be provided. 
top
 

Response Element: Put_Programs_of_Study_for_Enrollment_Response

Wrapper element for Put Programs of Study for Enrollment Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Financial_Aid_Record_Reference  Financial_Aid_RecordObject  [0..1]  Financial Aid Record that was processed   
top
 

Financial_Aid_RecordObject

part of: Put_Programs_of_Study_for_Enrollment_Response, Put_Programs_of_Study_for_Enrollment_Request
 
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
 

Programs_of_Study_for_Enrollment_Data

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