Service Directory > v31.2 > Student_Records > Import_Discontinue_Academic_Records
 

Operation: Import_Discontinue_Academic_Records

Import Discontinue Academic Records is an edit-only, high-volume web service task that provides the ability to discontinue multiple Academic Records at once.


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

Import Discontinue Academic Record Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  The Reference ID of the Discontinue Academic Record Data Load instance   
Discontinue_Academic_Record_HV_Data  Discontinue_Academic_Record_HV_Data  [0..*]  The high-volume data element for the Import Discontinue Academic Records web service task 
Validation Description
Please provide a reference to an academic record that does not have any active registrations or in progress BP events associated with it.   
The referenced academic record is inactive. Please provide a reference to an active academic record.   
You cannot discontinue the reporting record while there are current or future Non-zero Disbursements or Waiver Payments.   
 
Validation Description
Please provide a Discontinue Academic 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
 

Discontinue_Academic_Record_HV_Data

part of: Import_Discontinue_Academic_Record_Request
The high-volume data element for the Import Discontinue Academic Records web service task
 
Parameter name Type/Value Cardinality Description Validations
Academic_Record_Reference  Academic_RecordObject  [1..1]  The reference to the Academic Record that is to be discontinued   
Validation Description
Please provide a reference to an academic record that does not have any active registrations or in progress BP events associated with it.   
The referenced academic record is inactive. Please provide a reference to an active academic record.   
You cannot discontinue the reporting record while there are current or future Non-zero Disbursements or Waiver Payments.   
top
 

Academic_RecordObject

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

Academic_RecordObjectID

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

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
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top