Service Directory > v32.1 > Academic_Foundation > Get_Student_Tags
 

Operation: Get_Student_Tags

Returns Student Tags by Reference ID, or returns all Student Tags if no Reference IDs are specified.


@ - 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: Get_Student_Tags_Request

Wrapper element for Get Student Tags Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Tag_Request_References  [0..1]  Element containing the list of Student Tags for which data is requested.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Tags_Response

Wrapper element for the Student Tag Information returned as a result of a Get Student Tags request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Tag_Request_References  [0..1]  Element containing the list of Student Tags for which data is requested.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Student_Tag_Response_Data  [0..1]  Wrapper element for the Student Tag data.   
top
 

Student_Tag_Request_References

part of: Get_Student_Tags_Request, Get_Student_Tags_Response
Element containing the list of Student Tags for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Student_Tag_Reference  Student_TagObject  [1..*]  Workset of Student Tags for which data is requested.   
top
 

Student_TagObject

part of: Student_Tag_Request_References, Student_Tag
 
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
 

Response_Filter

part of: Get_Student_Tags_Request, Get_Student_Tags_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Student_Tags_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Student_Tag_Response_Data

part of: Get_Student_Tags_Response
Wrapper element for the Student Tag data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Tag  Student_Tag  [0..*]  Wrapper element for the Student Tag data.   
top
 

Student_Tag

part of: Student_Tag_Response_Data
Wrapper element for the Student Tag data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Tag_Reference  Student_TagObject  [0..1]  Reference ID for the Student Tag.   
Student_Tag_Data  Student_Tag_Data  [0..*]  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.   
 
top
 

Student_Tag_Data

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