Service Directory > v31.2 > Human_Resources > Get_Training_Types
 

Operation: Get_Training_Types

This operation retrieves Training Types defined in the system.


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

Request element for Get Training Types
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Training_Type_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Training Type and its associated data.   
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_Training_Types_Response

Response element for Get Training Types
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Training_Type_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Training Type and its associated data.   
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  Training_Type_Response_Data  [0..1]  Response element for Get Training Types   
top
 

Training_Type_Request_References

part of: Get_Training_Types_Request, Get_Training_Types_Response
Utilize the Request References element to retrieve a specific instance(s) of Training Type and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Training_Type_Reference  Training_TypeObject  [1..*]  A unique identifier used to reference a Training Type.   
top
 

Training_TypeObject

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

Training_TypeObjectID

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

Training_Type_Response_Data

part of: Get_Training_Types_Response
Response element for Get Training Types
 
Parameter name Type/Value Cardinality Description Validations
Training_Type  Training_Type  [0..*]  Encapsulating element containing all Training Type data.   
top
 

Training_Type

part of: Training_Type_Response_Data
Training Type Response Data
 
Parameter name Type/Value Cardinality Description Validations
Training_Type_Reference  Training_TypeObject  [0..1]  A unique identifier used to reference a Training Type.   
Training_Type_Data  Training_Type_Data  [0..*]  Contains the detailed information about a Training Type.   
top
 

Training_Type_Data

part of: Training_Type
Request element for Put Training
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID (Training_Type_ID)   
Training_Type_Name  string  [0..1]  The name of the Training Type. 
Validation Description
Name is required.   
 
Inactive  boolean  [0..1]  Indicates if the training type is inactive. If a training type is inactive, it will no longer be allowed to be selected when a user enters or updates their training.   
top
 

Training_TypeReferenceEnumeration

part of: Training_TypeObjectID
Base Type
string
top