Service Directory > v31.2 > Financial_Aid > Put_Federal_Verification_Status
 

Operation: Put_Federal_Verification_Status

This task can be used to update the Federal Verification Status for a Student given a Financial Aid Award Year and Federal School Code Rule Set. Note that this task is update only, it may not be used to assign a Student a Federal Verification Status if they do not yet have an ISIR transaction


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

This is the request element for the Put Federal Verification Status task
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Aid_Data  Federal_Verification_Status_Data  [1..1]  The data element for Federal Verification Status 
Validation Description
No ISIR exists for the given Student, Award Year, and Federal School Code  Ensures a Student Aid Instance exists for the inputted Student, Financial Aid Award Year and Federal School Code Rule Set 
Federal School Code Rule Set is not valid for the given Student  Ensures that only Federal School Code Rule Sets valid for the inputted Student are permitted 
Financial Aid Award Year is not valid for the given Student  Ensures that only Financial Aid Award Years valid for the inputted Student are permitted 
 
top
 

Response Element: Put_Federal_Verification_Status_Response

This is the response element for the Put Federal Verification Status task
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Reference  StudentObject  [0..1]  The Student Reference   
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [0..1]  The Financial Aid Award Year Reference   
Federal_School_Code_Rule_Set_Reference  Federal_School_Code_Rule_SetObject  [0..1]  The Federal School Code Rule Set Reference   
ISIR_Federal_Verification_Status_Reference  ISIR_Federal_Verification_StatusObject  [0..1]  The ISIR Federal Verification Status Reference   
top
 

Federal_Verification_Status_Data

part of: Put_Federal_Verification_Status_Request
Data element for the Put Federal Verification Status request
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  The Student Reference   
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [1..1]  The Financial Aid Award Year Reference   
Federal_School_Code_Rule_Set_Reference  Federal_School_Code_Rule_SetObject  [1..1]  The Federal School Code Rule Set Reference   
ISIR_Federal_Verification_Status_Reference  ISIR_Federal_Verification_StatusObject  [1..1]  The ISIR Federal Verification Status Reference   
Validation Description
No ISIR exists for the given Student, Award Year, and Federal School Code  Ensures a Student Aid Instance exists for the inputted Student, Financial Aid Award Year and Federal School Code Rule Set 
Federal School Code Rule Set is not valid for the given Student  Ensures that only Federal School Code Rule Sets valid for the inputted Student are permitted 
Financial Aid Award Year is not valid for the given Student  Ensures that only Financial Aid Award Years valid for the inputted Student are permitted 
top
 

StudentObject

part of: Put_Federal_Verification_Status_Response, Federal_Verification_Status_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  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
 

Financial_Aid_Award_YearObject

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

Financial_Aid_Award_YearObjectID

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

Federal_School_Code_Rule_SetObject

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

Federal_School_Code_Rule_SetObjectID

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

ISIR_Federal_Verification_StatusObject

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

ISIR_Federal_Verification_StatusObjectID

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

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Financial_Aid_Award_YearReferenceEnumeration

part of: Financial_Aid_Award_YearObjectID
Base Type
string
top
 

Federal_School_Code_Rule_SetReferenceEnumeration

part of: Federal_School_Code_Rule_SetObjectID
Base Type
string
top
 

ISIR_Federal_Verification_StatusReferenceEnumeration

part of: ISIR_Federal_Verification_StatusObjectID
Base Type
string
top