Service Directory > v32.1 > Academic_Foundation > Put_Student_Note_Topic
 

Operation: Put_Student_Note_Topic

Adds or updates a Student Note Topic using the information provided 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_Note_Topic_Request

Web Service Request Element for Add/Edit an Student Note Topic
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Indicates that this request may only be used to add a new tag, not modify an existing one.   
Student_Note_Topic_Reference  Student_Note_TopicObject  [0..1]  Element containing the Reference ID of the tag to modify (not present when adding a new tag)   
Student_Note_Topic_Data  Student_Note_Topic_Data  [1..1]  Web Service Element for Student Note Topic data   
Validation Description
The Web Service is set to Add Only, but the Student Note Topic already exists.   
top
 

Response Element: Put_Student_Note_Topic_Response

Web Service Element containing the Reference ID of the New/Modified Student Note Topic
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Note_Topic_Reference  Student_Note_TopicObject  [0..1]  Reference ID of the New/Modified Engagement Conversation Tag   
top
 

Student_Note_TopicObject

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

Student_Note_TopicObjectID

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

part of: Put_Student_Note_Topic_Request
Web Service Element for Student Note Topic data
 
Parameter name Type/Value Cardinality Description Validations
Student_Note_Topic_Name  string  [1..1]  Unique Name for Engagement Conversation Tag 
Validation Description
Enter a Tag Name that isn't already in use.   
 
Student_Note_Topic_Category_Reference  Student_Note_Topic_CategoryObject  [0..*]  Category for Engagement Conversation Tag   
top
 

Student_Note_Topic_CategoryObject

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

Student_Note_Topic_CategoryObjectID

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

part of: Student_Note_TopicObjectID
Base Type
string
top
 

Student_Note_Topic_CategoryReferenceEnumeration

part of: Student_Note_Topic_CategoryObjectID
Base Type
string
top