Service Directory > v31.2 > Academic_Foundation > Put_Student_Hold_Assignment
 

Operation: Put_Student_Hold_Assignment

Web Service to Put a Student Hold Assignment on a Student.


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

Web Service Request to Put or Modify a Student Hold Assignment
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  True if Add only web service request   
Student_Hold_Assignment_Reference  Student_Hold_AssignmentObject  [0..1]  The reference to the assignment of the Student Hold being updated   
Student_Hold_Assignment_Data  Student_Hold_Assignment_Data  [1..1]  The Element that has all the information relating to Hold Assignments 
Validation Description
Federal School Code Rule Set is only valid context for a Hold Type of ISIR Review, Disbursement, or Packaging.   
Award Year is only a valid context with a Hold Type of ISIR Review, Disbursement, or Packaging.   
The Hold Type is not a valid Hold Type for this Hold Reason.   
The Award Year needs to current, future, or one year prior.   
The Federal School Code Rule Set needs to be associated with the Academic Unit and Level for the Student.   
Academic Period must be current or in the future.   
Academic Period is only a valid context with a Hold Type of Full Registration and Registration Add.   
Academic Period must be on Academic Calendar for the Primary Program of Study for a Student Record.   
The Academic Record must be valid for the Student.   
Academic Period must be on Academic Calendar for the Students Primary Program Of Study.   
Academic Record is only valid if a Hold Type is Full Registration, Registration Add, Silent Full Registration, or Diploma.   
Hold assignments that have been removed cannot be updated or removed.   
Only existing hold assignments can be removed.   
You may not apply a duplicate hold.   
Student Hold Assignments cannot have Student Hold Reason of Outstanding Action Item.   
You cannot update the hold type for an existing hold assignment.   
You cannot update the hold reason for an existing hold assignment.   
You may only apply a hold assignment with one hold type.   
 
Student_Hold_Assignment_Override_Data  Student_Hold_Assignment_Override_Data  [0..1]  Wrapper element for Hold Override Data 
Validation Description
You can't override a refund hold.   
The End Date must be after the Start Date.   
The Start Date must be on or after today's date.   
You can only override existing hold assignments.   
You can't override holds with hold types that aren't applicable for this hold assignment.   
You can only override active hold assignments.   
You can't override a hold assignment that already has an active override.   
 
Validation Description
The Web Service is set to Add Only, but the Student Hold already exists.   
top
 

Response Element: Put_Student_Hold_Assignment_Response

Wrapper element for Put Student Hold Assignment returned data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Hold_Assignment_Reference  Student_Hold_AssignmentObject  [0..1]  The reference to the assignment of the Student Hold being updated   
top
 

Student_Hold_AssignmentObject

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

Student_Hold_AssignmentObjectID

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

part of: Put_Student_Hold_Assignment_Request
Element containing all the data to describe a Student Hold Assignment
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique identifier of the Student Hold Assignment   
Student_Reference  StudentObject  [1..1]  The Student to whom the Hold is assigned   
Student_Hold_Reference  Student_Hold__All_Object  [1..*]  The Holds the assignment references   
Hold_Reason_Reference  Student_Hold_Reason__All_Object  [1..1]  The Reason the Hold is applied   
Remove  boolean  [0..1]  Include a removal date to remove an existing holdable assignment from a student.   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Valid Academic Record for Student. If no Academic Record is submitted, then a hold assignment applies to all academic records.   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Academic Period Hold Context for Registration Holds   
Award_Year_Reference  Financial_Aid_Award_YearObject  [0..1]  The Award Year for Financial Aid Holds.   
Federal_School_Code_Rule_Set_Reference  Federal_School_Code_Rule_SetObject  [0..1]  The Federal School Code Rule Set for Financial Aid Holds. Required if the Hold Type is Packaging, Disbursement, or ISIR Review.   
Validation Description
Federal School Code Rule Set is only valid context for a Hold Type of ISIR Review, Disbursement, or Packaging.   
Award Year is only a valid context with a Hold Type of ISIR Review, Disbursement, or Packaging.   
The Hold Type is not a valid Hold Type for this Hold Reason.   
The Award Year needs to current, future, or one year prior.   
The Federal School Code Rule Set needs to be associated with the Academic Unit and Level for the Student.   
Academic Period must be current or in the future.   
Academic Period is only a valid context with a Hold Type of Full Registration and Registration Add.   
Academic Period must be on Academic Calendar for the Primary Program of Study for a Student Record.   
The Academic Record must be valid for the Student.   
Academic Period must be on Academic Calendar for the Students Primary Program Of Study.   
Academic Record is only valid if a Hold Type is Full Registration, Registration Add, Silent Full Registration, or Diploma.   
Hold assignments that have been removed cannot be updated or removed.   
Only existing hold assignments can be removed.   
You may not apply a duplicate hold.   
Student Hold Assignments cannot have Student Hold Reason of Outstanding Action Item.   
You cannot update the hold type for an existing hold assignment.   
You cannot update the hold reason for an existing hold assignment.   
You may only apply a hold assignment with one hold type.   
top
 

StudentObject

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

Student_Hold__All_Object

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

Student_Hold__All_ObjectID

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

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

Student_Hold_Reason__All_ObjectID

part of: Student_Hold_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_Hold_Reason_ID, Tenanted_Student_Hold_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
 

Academic_RecordObject

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

Academic_PeriodObject

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

Financial_Aid_Award_YearObject

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

Financial_Aid_Award_YearObjectID

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

Federal_School_Code_Rule_SetObject

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

Federal_School_Code_Rule_SetObjectID

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

part of: Put_Student_Hold_Assignment_Request
Wrapper element for Hold Override Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique identifier of the Student Hold Assignment Override Event   
Student_Hold__All__Reference  Student_Hold__All_Object  [1..*]  Reference to the Student Hold (All) being overridden   
Override_Start_Date  date  [1..1]  The start date for the hold override   
Override_End_Date  date  [1..1]  The end date for the hold override   
Validation Description
You can't override a refund hold.   
The End Date must be after the Start Date.   
The Start Date must be on or after today's date.   
You can only override existing hold assignments.   
You can't override holds with hold types that aren't applicable for this hold assignment.   
You can only override active hold assignments.   
You can't override a hold assignment that already has an active override.   
top
 

Student_Hold_AssignmentReferenceEnumeration

part of: Student_Hold_AssignmentObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Student_Hold__All_ReferenceEnumeration

part of: Student_Hold__All_ObjectID
Base Type
string
top
 

Student_Hold_Reason__All_ReferenceEnumeration

part of: Student_Hold_Reason__All_ObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Financial_Aid_Award_YearReferenceEnumeration

part of: Financial_Aid_Award_YearObjectID
Base Type
string
top
 

Federal_School_Code_Rule_SetReferenceEnumeration

part of: Federal_School_Code_Rule_SetObjectID
Base Type
string
top