Service Directory > v31.2 > Academic_Foundation > Put_Student_Tag
 

Operation: Put_Student_Tag

Adds a new Student Tag (or updates an existing Student Tag) with the information supplied in the request.


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

Wrapper element for the Put Student Tag Request information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Student_Tag_Reference  Student_TagObject  [0..1]  The reference to the Student Tag being updated. For new Student Tags, this element will not exist.   
Student_Tag_Data  Student_Tag_Data  [0..1]  Wrapper element for the Student Tag Data. 
Validation Description
Enter a Student Tag Name not already in use.   
You cannot edit an Academic Unit for a Student Tag already in use.   
You cannot edit an Academic Level for a Student Tag already in use.   
You cannot add an Inactive Student Tag Category to an Active Student Tag.   
 
Validation Description
The web service is set to add only but the Student Tag already exists.   
top
 

Response Element: Put_Student_Tag_Response

Wrapper element for the Put Student Tag returned data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Tag_Reference  Student_TagObject  [0..1]  The reference to the Student Tag which was added or updated.   
top
 

Student_TagObject

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

Student_TagObjectID

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

part of: Put_Student_Tag_Request
Wrapper element for the Student Tag Data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Tag_Name  string  [1..1]  Student Tag Name.   
Student_Tag_Category_Reference  Student_Tag_CategoryObject  [0..*]  Student Tag Categories the Student Tag is in.   
Academic_Unit_Shareable_Data  Has_Academic_Unit_with_Shareable_Subordinates_Data  [1..1]  Academic Unit Data with Shareable with Subordinates Data 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Student_Tag_Inactive  boolean  [0..1]  The Status of the Student Tag.   
Validation Description
Enter a Student Tag Name not already in use.   
You cannot edit an Academic Unit for a Student Tag already in use.   
You cannot edit an Academic Level for a Student Tag already in use.   
You cannot add an Inactive Student Tag Category to an Active Student Tag.   
top
 

Student_Tag_CategoryObject

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

Student_Tag_CategoryObjectID

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

Has_Academic_Unit_with_Shareable_Subordinates_Data

part of: Student_Tag_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_TagReferenceEnumeration

part of: Student_TagObjectID
Base Type
string
top
 

Student_Tag_CategoryReferenceEnumeration

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