Service Directory > v31.2 > Student_Records > Put_Student_Course_Tag
 

Operation: Put_Student_Course_Tag

Adds a new Student Course Tag (or updates an existing Student Course 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_Course_Tag_Request

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

Response Element: Put_Student_Course_Tag_Response

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

Student_Course_TagObject

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

Student_Course_TagObjectID

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

part of: Put_Student_Course_Tag_Request
Wrapper element for the Student Course Tag data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Course_Tag_Name  string  [1..1]  Student Course Tag Name.   
Has_Institution_Academic_Unit_Data  Has_Institution_Academic_Unit_Data  [1..1]  Course Subject Data   
Student_Course_Tag_Category_Reference  Student_Course_Tag_CategoryObject  [0..1]  Student Course Tag Categories the Student Course Tag is in.   
Validation Description
Enter a Course Tag Name not already in use.   
top
 

Has_Institution_Academic_Unit_Data

part of: Student_Course_Tag_Data
Course Subject Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_UnitObject  [1..*]  Academic Unit Reference   
top
 

Academic_UnitObject

part of: Has_Institution_Academic_Unit_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_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
 

Student_Course_Tag_CategoryObject

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

Student_Course_Tag_CategoryObjectID

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

part of: Student_Course_TagObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Student_Course_Tag_CategoryReferenceEnumeration

part of: Student_Course_Tag_CategoryObjectID
Base Type
string
top