Service Directory > v33.1 > Academic_Foundation > Get_Student_Hold_Assignments
 

Operation: Get_Student_Hold_Assignments

Web Service to Get Student Hold Assignments and information relating to the Holds.


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

Request to Get Student Hold Assignments that can be filtered by Specific Holds, Criteria, and Filters
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Hold_Assignment_Request_References  [0..1]  Element to select specific Student Hold Assignments to return   
Request_Criteria [Choice]   Student_Hold_Assignment_Request_Criteria  [0..1]  Contains criteria to specify which Student Hold Assignments to return   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Hold_Assignments_Response

Web Service Request to Get Student Hold Assignments
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Hold_Assignment_Request_References  [0..1]  Element to select specific Student Hold Assignments to return   
Request_Criteria  Student_Hold_Assignment_Request_Criteria  [0..1]  Contains criteria to specify which Student Hold Assignments to return   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Student_Hold_Assignment_Response_Data  [0..1]  Contains specified Hold Assignments and information relating to the Hold Assignments   
top
 

Student_Hold_Assignment_Request_References

part of: Get_Student_Hold_Assignments_Request, Get_Student_Hold_Assignments_Response
Element to select specific Student Hold Assignments to return
 
Parameter name Type/Value Cardinality Description Validations
Student_Hold_Assignment_Reference  Student_HoldObject  [1..*]  Specific Student Hold Assignments to return   
top
 

Student_HoldObject

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

Student_HoldObjectID

part of: Student_HoldObject
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_Request_Criteria

part of: Get_Student_Hold_Assignments_Request, Get_Student_Hold_Assignments_Response
Contains criteria to specify which Student Hold Assignments to return
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Specific reference to the Student, for whose Student Hold Assignments to return   
Student_Hold_Reference  Student_Hold_Type__All_Object  [0..*]  Specific reference to the Student Hold, for which Student Hold Assignments to return   
Student_Hold_Reason_Reference  Student_Hold_Reason__All_Object  [0..1]  Specific reference to the Student Hold Reason, for which Student Hold Assignments to return   
top
 

StudentObject

part of: Student_Hold_Assignment_Request_Criteria, Student_and_Universal_ID_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_Type__All_Object

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

Student_Hold_Type__All_ObjectID

part of: Student_Hold_Type__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_Request_Criteria, Student_Hold_Assignment_with_Multiple_Hold_Types_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
 

Response_Filter

part of: Get_Student_Hold_Assignments_Request, Get_Student_Hold_Assignments_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is the first page(Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Student_Hold_Assignments_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Student_Hold_Assignment_Response_Data

part of: Get_Student_Hold_Assignments_Response
Contains specified Hold Assignments and information relating to the Hold Assignments
 
Parameter name Type/Value Cardinality Description Validations
Student_Hold_Assignment  Student_Hold_Assignment  [0..*]  Element with Student Hold Assignment and Information relating to the Hold Assignment   
top
 

Student_Hold_Assignment

part of: Student_Hold_Assignment_Response_Data
Element with Student Hold Assignment and Information relating to the Hold Assignment
 
Parameter name Type/Value Cardinality Description Validations
Student_Hold_Assignment_Reference  Student_HoldObject  [0..1]  The Student Hold Assignment   
Student_Hold_Assignment_Data  Student_Hold_Assignment_with_Multiple_Hold_Types_Data  [0..*]  Element containing all the data to describe a Student Hold Assignment 
Validation Description
You may not apply a duplicate hold.   
Only existing hold assignments can be removed.   
Hold assignments that have been removed cannot be updated or removed.   
Enter the same Academic Period for each Hold Type.   
Enter the same Academic Record for each Hold Type.   
You cannot update the hold reason for an existing hold assignment.   
Enter the same Financial Aid Award Year for each Hold Type.   
Student Hold Assignments cannot have Student Hold Reason of Outstanding Action Item.   
Enter the same Federal School Code Rule Set for each Hold Type.   
You can't select the same Hold Type more than once.   
You can't update the hold types for an existing hold assignment.   
Enter the same Institutional Academic Unit for each Hold Type.   
You can't create a new student hold assignment with the delivered hold reason Past Due Balance.   
You can't change the student the hold is applied to.   
 
Student_Hold_Assignment_Override_Data  Student_Hold_Assignment_Override_Data  [0..*]  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.   
 
top
 

Student_Hold_Assignment_with_Multiple_Hold_Types_Data

part of: Student_Hold_Assignment
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_and_Universal_ID_Data  Student_and_Universal_ID_Data  [1..1]  Reference to Student using Student or Universal ID 
Validation Description
You can only refer to one Student when entering a Universal ID and/or a Student ID.   
 
Student_Hold_Reason_Reference  Student_Hold_Reason__All_Object  [1..1]  The Reason the Hold is applied   
Student_Hold_Type_and_Context_Data  Student_Hold_Type_and_Context_Data  [1..*]  Reference to Hold Type Context 
Validation Description
Federal School Code Rule Set is a valid context only for a Hold Type of Disbursement or Packaging.   
Award Year is a valid context only for a Hold Type of Disbursement or Packaging.   
Academic Period is a valid context only for a Hold Type of Full Registration or Registration Add.   
The Hold Type is not a valid Hold Type for this Hold Reason.   
You can only use an academic period that is on the academic calendar for the primary program of study on the academic record.   
Academic Record is a valid context only for a Hold Type of Full Registration, Registration Add, Silent Full Registration, or Diploma.   
Academic Period must be on the Academic Calendar for the Student's Primary Program of Study.   
The Award Year needs to be current, in the future, or 1 year prior.   
The Academic Record must be valid for the Student.   
Academic Period must be current or in the future.   
The Federal School Code Rule Set needs to be associated with the Academic Unit and Level for the Student.   
Enter either an Academic Record or an Institution for Registration & Diploma Holds, or leave both blank.   
Enter either a Federal School Code or an Institution for Packaging & Disbursement Holds, or leave both blank.   
Institution is not a valid context for a Hold Type of Transcript.   
You can only use an academic period that is on the academic calendar for the primary program of study on an academic record for the institution.   
The Context Academic Unit must be Institutional.   
 
Remove  boolean  [0..1]  Set this to True if in order to remove this hold assignment. This is for existing hold assignments only.   
Validation Description
You may not apply a duplicate hold.   
Only existing hold assignments can be removed.   
Hold assignments that have been removed cannot be updated or removed.   
Enter the same Academic Period for each Hold Type.   
Enter the same Academic Record for each Hold Type.   
You cannot update the hold reason for an existing hold assignment.   
Enter the same Financial Aid Award Year for each Hold Type.   
Student Hold Assignments cannot have Student Hold Reason of Outstanding Action Item.   
Enter the same Federal School Code Rule Set for each Hold Type.   
You can't select the same Hold Type more than once.   
You can't update the hold types for an existing hold assignment.   
Enter the same Institutional Academic Unit for each Hold Type.   
You can't create a new student hold assignment with the delivered hold reason Past Due Balance.   
You can't change the student the hold is applied to.   
top
 

Student_and_Universal_ID_Data

part of: Student_Hold_Assignment_with_Multiple_Hold_Types_Data
Reference to Student using Student or Universal ID
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  The Student who is being Referenced.   
Universal_ID_Reference  Universal_IdentifierObject  [0..1]  Universal ID of the Student who is being Referenced.   
Validation Description
You can only refer to one Student when entering a Universal ID and/or a Student ID.   
top
 

Universal_IdentifierObject

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

Universal_IdentifierObjectID

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

part of: Student_Hold_Assignment_with_Multiple_Hold_Types_Data
Element containing all the data to describe the context for a Student Hold Type
 
Parameter name Type/Value Cardinality Description Validations
Student_Hold_Type_Reference  Student_Hold_Type__Workday_Delivered_Object  [1..1]  The Hold the assignment references   
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 Award Year for Financial Aid Holds.   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [0..1]  Academic Unit Hold Context for Registration, Diploma, Refund, Charge Assessment, and Financial Aid Holds.   
Validation Description
Federal School Code Rule Set is a valid context only for a Hold Type of Disbursement or Packaging.   
Award Year is a valid context only for a Hold Type of Disbursement or Packaging.   
Academic Period is a valid context only for a Hold Type of Full Registration or Registration Add.   
The Hold Type is not a valid Hold Type for this Hold Reason.   
You can only use an academic period that is on the academic calendar for the primary program of study on the academic record.   
Academic Record is a valid context only for a Hold Type of Full Registration, Registration Add, Silent Full Registration, or Diploma.   
Academic Period must be on the Academic Calendar for the Student's Primary Program of Study.   
The Award Year needs to be current, in the future, or 1 year prior.   
The Academic Record must be valid for the Student.   
Academic Period must be current or in the future.   
The Federal School Code Rule Set needs to be associated with the Academic Unit and Level for the Student.   
Enter either an Academic Record or an Institution for Registration & Diploma Holds, or leave both blank.   
Enter either a Federal School Code or an Institution for Packaging & Disbursement Holds, or leave both blank.   
Institution is not a valid context for a Hold Type of Transcript.   
You can only use an academic period that is on the academic calendar for the primary program of study on an academic record for the institution.   
The Context Academic Unit must be Institutional.   
top
 

Student_Hold_Type__Workday_Delivered_Object

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

Student_Hold_Type__Workday_Delivered_ObjectID

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

Academic_RecordObject

part of: Student_Hold_Type_and_Context_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_Type_and_Context_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_Type_and_Context_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_Type_and_Context_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
 

Academic_UnitObject

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

Academic_UnitObjectID

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

part of: Student_HoldObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Student_Hold_Type__All_ReferenceEnumeration

part of: Student_Hold_Type__All_ObjectID
Base Type
string
top
 

Student_Hold_Reason__All_ReferenceEnumeration

part of: Student_Hold_Reason__All_ObjectID
Base Type
string
top
 

Universal_IdentifierReferenceEnumeration

part of: Universal_IdentifierObjectID
Base Type
string
top
 

Student_Hold_Type__Workday_Delivered_ReferenceEnumeration

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

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top