Service Directory > v31.2 > Financial_Aid > Import_Student_Eligibility_Codes
 

Operation: Import_Student_Eligibility_Codes

This process uses a Put-type web service operation to load Student Federal Aid Eligibility Codes for a large number of Students. However, instead of loading all the Student Eligibility Codes in a single transaction, the Import Web Service Process splits up the request into smaller chunks that are processed in separate XpressO Jobs.


@ - 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: Import_Student_Eligibility_Code_Request

Import Student Eligibility Code
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  ID   
Student_Eligibility_Code_Data  Import_Student_Eligibility_Code_HV_Data  [0..*]  Student (HV) Data Element   
Validation Description
Please enter a Student Eligibility Code Data Load ID that is not already in use.   
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Import_Student_Eligibility_Code_HV_Data

part of: Import_Student_Eligibility_Code_Request
Student (HV) Data Element
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  Student Reference   
Eligibility_Code_Data  Import_Student_Eligibility_Code_Data  [1..1]  Student Eligibility Code Data 
Validation Description
The following field is required: Ability to Benefit Completion Date.   
The following field is required: Ability To Benefit Test Administrator Code.   
The following field is required: Ability To Benefit Test Code.   
 
top
 

StudentObject

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

Import_Student_Eligibility_Code_Data

part of: Import_Student_Eligibility_Code_HV_Data
Student Eligibility Code Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Federal_Aid_Eligibility_Code_Reference  Student_Federal_Aid_Eligibility_CodeObject  [1..1]  Reference to a Student Federal Aid Eligibility Code.   
Ability_to_Benefit_Test_Administrator_Code_Reference  Ability_to_Benefit_Test_Administrator_CodeObject  [0..1]  Reference to an Ability to Benefit Test Administrator Code.   
Ability_to_Benefit_Test_Code_Reference  Ability_to_Benefit_Test_CodeObject  [0..1]  Reference to an Ability to Benefit Test Code   
Student_Ability_to_Benefit_Completion_Date  date  [0..1]  The Ability to Benefit Completion Date.   
Validation Description
The following field is required: Ability to Benefit Completion Date.   
The following field is required: Ability To Benefit Test Administrator Code.   
The following field is required: Ability To Benefit Test Code.   
top
 

Student_Federal_Aid_Eligibility_CodeObject

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

Student_Federal_Aid_Eligibility_CodeObjectID

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

Ability_to_Benefit_Test_Administrator_CodeObject

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

Ability_to_Benefit_Test_Administrator_CodeObjectID

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

Ability_to_Benefit_Test_CodeObject

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

Ability_to_Benefit_Test_CodeObjectID

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

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Student_Federal_Aid_Eligibility_CodeReferenceEnumeration

part of: Student_Federal_Aid_Eligibility_CodeObjectID
Base Type
string
top
 

Ability_to_Benefit_Test_Administrator_CodeReferenceEnumeration

part of: Ability_to_Benefit_Test_Administrator_CodeObjectID
Base Type
string
top
 

Ability_to_Benefit_Test_CodeReferenceEnumeration

part of: Ability_to_Benefit_Test_CodeObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top