Service Directory > v25.1 > Academic_Foundation > Put_Student_Tag_Category
 

Operation: Put_Student_Tag_Category

Adds a new Student Tag Category (or updates an existing Student Tag Category) 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_Category_Request

Wrapper element for the Put Student Tag Category 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_Category_Reference  Student_Tag_CategoryObject  [0..1]  The reference to the Student Tag Category being updated. For new Student Tag Categories, this element will not exist.   
Student_Tag_Category_Data  Student_Tag_Category_Data  [0..1]  Contains Student Tag Category Data 
Validation Description
Enter a Student Tag Category Name not already in use.   
 
Validation Description
The web service is set to add only but the Student Tag Category already exists.   
top
 

Response Element: Put_Student_Tag_Category_Response

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

Student_Tag_CategoryObject

part of: Put_Student_Tag_Category_Request, Put_Student_Tag_Category_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_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
 

Student_Tag_Category_Data

part of: Put_Student_Tag_Category_Request
Wrapper element for the Student Tag Category Data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Tag_Category_Name  string  [1..1]  Student Tag Category Name.   
Validation Description
Enter a Student Tag Category Name not already in use.   
top
 

Student_Tag_CategoryReferenceEnumeration

part of: Student_Tag_CategoryObjectID
Base Type
string
top