Service Directory > v31.2 > Academic_Foundation > Put_Student_Hold_Reason
 

Operation: Put_Student_Hold_Reason

This web service task will create or update Student Hold Reasons


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

Put Student Hold Reason Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add only boolean   
Student_Hold_Reason_Reference  Student_Hold_ReasonObject  [0..1]  Workset for a Singular Student hold reason   
Student_Hold_Reason_Data  Student_Hold_Reason_Data  [1..1]  Subelement for student hold reason data   
Validation Description
The web service is set to add only, but the Student Hold Reason already exists.   
top
 

Response Element: Put_Student_Hold_Reason_Response

Put Student Hold Reason Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Hold_Reason_Reference  Student_Hold_ReasonObject  [0..1]  Workset for Singular Student Hold Reason   
top
 

Student_Hold_ReasonObject

part of: Put_Student_Hold_Reason_Request, Put_Student_Hold_Reason_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_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_Data

part of: Put_Student_Hold_Reason_Request
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__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__Workday_Delivered_Object

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

Student_Hold__Workday_Delivered_ObjectID

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

Student_Hold_ReasonReferenceEnumeration

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

Student_Hold__Workday_Delivered_ReferenceEnumeration

part of: Student_Hold__Workday_Delivered_ObjectID
Base Type
string
top