Service Directory > v31.2 > Academic_Foundation > Import_Student_Period_Record_Overrides
 

Operation: Import_Student_Period_Record_Overrides

This task can edit existing Student Period Records by the Student Period Record reference ID, or by supplying a student and an academic period. It will use the student's active student record and pick the Student Period Record based on academic period.


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

Request for the high volume import request for Student Period Records
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  The ID to use for the Student Period Record Data Load   
Student_Period_Record_HV_Data  Import_Student_Period_Record_Overrides__HV__Data  [0..*]  Data element for high volume edit of Student Period Record   
Validation Description
Enter a Student Period Record 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_Period_Record_Overrides__HV__Data

part of: Import_Student_Period_Record_Overrides_Request
Data element for high volume edit of Student Period Record
 
Parameter name Type/Value Cardinality Description Validations
Student_Period_Record_Reference  Financial_Aid_Period_RecordObject  [0..1]  Instance of Student Period Record to edit   
Student_Period_Record_Data  Student_Period_Record_Overrides_Data  [0..*]  Wrapper element for Student Period Record Data 
Validation Description
The supplied Student Period Record does not match the Student and Academic Period or does not exist.   
Submit either Student Reference or Financial Aid Record Reference.   
Student has more than one Financial Aid Record. Please provide a reference to the Financial Aid Record.   
Entered Student must be matriculated.   
 
top
 

Financial_Aid_Period_RecordObject

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

Financial_Aid_Period_RecordObjectID

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

Student_Period_Record_Overrides_Data

part of: Import_Student_Period_Record_Overrides__HV__Data
Wrapper element for Student Period Record Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Period Record   
Student_Reference  StudentObject  [0..1]  Student Record for which the Student Period Record belongs   
Financial_Aid_Record_Reference  Financial_Aid_RecordObject  [0..1]  Financial Aid Record for which the Financial Aid Period Record belongs   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period for which the Student Period Record belongs   
Satisfactory_Academic_Progress_Status_Reference  Satisfactory_Academic_Progress_StatusObject  [1..1]  Satisfactory Academic Progress Status for Student Period Record   
On_Academic_Plan  boolean  [0..1]  Is SAP status on Financial Aid Academic Plan   
Number_of_Appeals_Granted  decimal (3, 0) >0   [0..1]  Number of appeals granted   
Validation Description
The supplied Student Period Record does not match the Student and Academic Period or does not exist.   
Submit either Student Reference or Financial Aid Record Reference.   
Student has more than one Financial Aid Record. Please provide a reference to the Financial Aid Record.   
Entered Student must be matriculated.   
top
 

StudentObject

part of: Student_Period_Record_Overrides_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_RecordObject

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

Academic_PeriodObject

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

Academic_PeriodObjectID

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

Satisfactory_Academic_Progress_StatusObject

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

Satisfactory_Academic_Progress_StatusObjectID

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

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
 

Financial_Aid_Period_RecordReferenceEnumeration

part of: Financial_Aid_Period_RecordObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Financial_Aid_RecordReferenceEnumeration

part of: Financial_Aid_RecordObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Satisfactory_Academic_Progress_StatusReferenceEnumeration

part of: Satisfactory_Academic_Progress_StatusObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top