Service Directory > v32.1 > Student_Records > Import_Student_Dismissal_Events
 

Operation: Import_Student_Dismissal_Events

Import Student Dismissal Events is a web service task that provides the ability for an administrator to dismiss students from an academic institution.


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

Import Student Dismissal Event Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  The Reference ID of the Student Dismissal Event Data Load instance   
Import_Student_Dismissal_Data  Import_Student_Dismissal_Data  [0..*]  The high-volume data element for the Import Student Dismissal Events web service task 
Validation Description
Student has more than one Academic Record. Please submit Academic Record Reference.   
For students with only 1 academic record, specify a Student Reference. For students with multiple academic records, specify an Academic Record Reference.   
You can't change the status of this academic record until the business process in progress is complete.   
Please provide an academic record that is active as of the dismissal start date.   
You can initiate a dismissal only for academic records that are in progress.   
 
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_Dismissal_Data

part of: Import_Student_Dismissal_Event_Request
Data for the web service task to dismiss students
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  The reference to the Student whose Academic Record will be Dismissed   
Academic_Record_Reference  Academic_RecordObject  [0..1]  The reference to the Academic Record that is to be dismissed   
Student_Dismissal_Start_Date  date  [1..1]  The effective start date of dismissal   
Dismissal_Reason_Reference  Student_Program_of_Study_Record_Status_Reason__All_Object  [0..1]  Student Program of Study Record Status Reason (All)   
Validation Description
Student has more than one Academic Record. Please submit Academic Record Reference.   
For students with only 1 academic record, specify a Student Reference. For students with multiple academic records, specify an Academic Record Reference.   
You can't change the status of this academic record until the business process in progress is complete.   
Please provide an academic record that is active as of the dismissal start date.   
You can initiate a dismissal only for academic records that are in progress.   
top
 

StudentObject

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

Academic_RecordObject

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

Student_Program_of_Study_Record_Status_Reason__All_Object

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

Student_Program_of_Study_Record_Status_Reason__All_ObjectID

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

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Student_Program_of_Study_Record_Status_Reason__All_ReferenceEnumeration

part of: Student_Program_of_Study_Record_Status_Reason__All_ObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top