Service Directory > v32.1 > Academic_Foundation > Get_Student_Hold_Reasons
 

Operation: Get_Student_Hold_Reasons

This web service will retrieve data about a Student Hold Reason, including its name, description, resolution instructions, and which hold types it applies to.


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

Get Student Hold Reason Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Hold_Reason_Request_References  [0..1]  Student Hold Reason Request References Element   
Request_Criteria [Choice]   Student_Hold_Reason_Request_Criteria  [0..1]  Student Hold Reason request element for GET request   
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_Reasons_Response

Get Student Hold Reasons Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Hold_Reason_Request_References  [0..1]  Student Hold Reason Request References element   
Request_Criteria  Student_Hold_Reason_Request_Criteria  [0..1]  Student Hold Reason Request Criteria element   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results element   
Response_Data  Student_Hold_Reason_Response_Data  [0..1]  Student Hold Reason Response Data element   
top
 

Student_Hold_Reason_Request_References

part of: Get_Student_Hold_Reasons_Response, Get_Student_Hold_Reasons_Request
Student Hold Reason Request References Element
 
Parameter name Type/Value Cardinality Description Validations
Student_Hold_Reason_Reference  Student_Hold_ReasonObject  [1..*]  Nonsingular workset for student hold reasons   
top
 

Student_Hold_ReasonObject

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

Student_Hold_ReasonObjectID

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

Student_Hold_Reason_Request_Criteria

part of: Get_Student_Hold_Reasons_Response, Get_Student_Hold_Reasons_Request
Student Hold Reason Request Criteria element
 
Parameter name Type/Value Cardinality Description Validations
Inactive_Hold_Reference  boolean  [0..1]  Inactive Hold Option to Request Inactive Holds for the Get Hold Reason Task   
Hold_Type_Reference  Student_Hold_Type__Workday_Delivered_Object  [0..*]  Hold Type to request Hold Reasons that are restricted by this Hold Type for the Get Hold Reasons Task   
In_Use_Reference  boolean  [0..1]  Request Student Hold Reasons by In Use Hold Reasons   
Academic_Unit_Reference  Academic_UnitObject  [0..*]  Get student hold reason by Academic Unit   
top
 

Student_Hold_Type__Workday_Delivered_Object

part of: Student_Hold_Reason_Data, Student_Hold_Reason_Request_Criteria
 
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_UnitObject

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

Response_Filter

part of: Get_Student_Hold_Reasons_Response, Get_Student_Hold_Reasons_Request
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, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to 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 (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Student_Hold_Reasons_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 have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Student_Hold_Reason_Response_Data

part of: Get_Student_Hold_Reasons_Response
Get Student Hold Reasons Response element
 
Parameter name Type/Value Cardinality Description Validations
Student_Hold_Reason  Student_Hold_Reason  [0..*]  Student Hold Reason element   
top
 

Student_Hold_Reason

part of: Student_Hold_Reason_Response_Data
Student Hold Reason Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Student_Hold_Reason_Reference  Student_Hold_ReasonObject  [0..1]  Reference for Student Hold reason   
Student_Hold_Reason_Data  Student_Hold_Reason_Data  [0..*]  Student Hold Reason Data element   
top
 

Student_Hold_Reason_Data

part of: Student_Hold_Reason
Student Hold Reason Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Hold Reason 
Validation Description
A Hold Reason with the same Name, Academic Unit, and Academic Level already exists.   
 
Has_Academic_Unit_With_Shareable_Subordinates_Data  Has_Academic_Unit_with_Shareable_Subordinates_Data  [1..*]  Academic Unit Data with Shareable with Subordinates Data 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Name  string  [1..1]  Student Hold Reason Name   
Description  RichText  [0..1]  Student Hold Reason Description   
Resolution  RichText  [0..1]  Student Hold Reason Resolution   
Hold_Reference  Student_Hold_Type__Workday_Delivered_Object  [1..*]  Hold for Student Hold Reason   
Inactive  boolean  [0..1]  Inactive Student Hold Reason Boolean   
top
 

Has_Academic_Unit_with_Shareable_Subordinates_Data

part of: Student_Hold_Reason_Data
Academic Unit Data with Shareable with Subordinates Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level for Has Academic Unit with Shareable Subordinates Data element   
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_Curricular_DivisionObject

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

Academic_Curricular_DivisionObjectID

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

Academic_LevelObject

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

Academic_LevelObjectID

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

part of: Student_Hold_ReasonObjectID
Base Type
string
top
 

Student_Hold_Type__Workday_Delivered_ReferenceEnumeration

part of: Student_Hold_Type__Workday_Delivered_ObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

RichText

part of: Student_Hold_Reason_Data, Student_Hold_Reason_Data
Base Type
string
top