Service Directory > v32.1 > Student_Records > Import_Student_Suspensions
 

Operation: Import_Student_Suspensions

Import Student Suspensions is an edit-only, high-volume web service task that provides the ability to suspend 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_Student_Suspension_Request

Import Student Suspension Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  Reference ID for the Student Suspension Event Data Load   
Import_Student_Suspension_Data  Import_Student_Suspension_Data  [0..*]  Import Student Suspension Data element 
Validation Description
Specify an academic record that is active on the suspension return date for the student.   
Specify a suspension start date that is on or after today.   
The program of study status reason isn't eligible for the selected criteria.   
You can initiate a suspension only for academic records that are in progress.   
Specify an academic record that is active as of the suspension start date.   
You can't change the status of this academic record until the business process in progress is complete.   
Specify a return date that is after the suspension start date.   
Provide a reference to either an academic record, or a student with only one academic record.   
The referenced student has more than one academic record. Provide a reference to one of the academic records for the student.   
 
Validation Description
Specify a Student Suspension Event Data Load ID that isn't 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_Suspension_Data

part of: Import_Student_Suspension_Request
Import Student Suspension Data element
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Reference   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Academic Record Reference   
Suspension_Start_Date  date  [1..1]  Student Suspension Start Date   
Suspension_Eligible_Return_Date  date  [1..1]  Student Suspension Eligible Return Date   
Suspension_Reason_Reference  Student_Program_of_Study_Record_Status_Reason__All_Object  [0..1]  Suspension Reason Reference   
Validation Description
Specify an academic record that is active on the suspension return date for the student.   
Specify a suspension start date that is on or after today.   
The program of study status reason isn't eligible for the selected criteria.   
You can initiate a suspension only for academic records that are in progress.   
Specify an academic record that is active as of the suspension start date.   
You can't change the status of this academic record until the business process in progress is complete.   
Specify a return date that is after the suspension start date.   
Provide a reference to either an academic record, or a student with only one academic record.   
The referenced student has more than one academic record. Provide a reference to one of the academic records for the student.   
top
 

StudentObject

part of: Import_Student_Suspension_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_Suspension_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_Suspension_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