Service Directory > v32.1 > Recruiting > Get_Recruiting_Assessment_Categories
 

Operation: Get_Recruiting_Assessment_Categories

Returns Recruiting Assessment Categories data.


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

Retrieves Recruiting Assessment Categories
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Recruiting_Assessment_Category_Request_References  [0..1]  Container with reference to Recruiting Assessment Category   
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_Group  Recruiting_Assessment_Category_Response_Group  [0..*]  Container for Determining whether or not to include reference   
top
 

Response Element: Get_Recruiting_Assessment_Categories_Response

Get Recruiting Assessment Categories Response Container
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Recruiting_Assessment_Category_Request_References  [0..1]  Container with reference to Recruiting Assessment Category   
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_Group  Recruiting_Assessment_Category_Response_Group  [0..*]  Container for Determining whether or not to include reference   
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  Recruiting_Assessment_Category_Response_Data  [0..1]  Recruiting Assessment Category Response Data   
top
 

Recruiting_Assessment_Category_Request_References

part of: Get_Recruiting_Assessment_Categories_Request, Get_Recruiting_Assessment_Categories_Response
Container with reference to Recruiting Assessment Category
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Assessment_Category_Reference  Recruiting_Assessment_CategoryObject  [1..*]  References Recruiting Assessment Category   
top
 

Recruiting_Assessment_CategoryObject

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

Recruiting_Assessment_CategoryObjectID

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

Response_Filter

part of: Get_Recruiting_Assessment_Categories_Request, Get_Recruiting_Assessment_Categories_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
 

Recruiting_Assessment_Category_Response_Group

part of: Get_Recruiting_Assessment_Categories_Request, Get_Recruiting_Assessment_Categories_Response
Container for Determining whether or not to include reference
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Includes Reference in Response   
top
 

Response_Results

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

Recruiting_Assessment_Category_Response_Data

part of: Get_Recruiting_Assessment_Categories_Response
Recruiting Assessment Category Response Data
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Assessment_Category  Recruiting_Assessment_Category  [0..*]  Recruiting Assessment Category Response Container   
top
 

Recruiting_Assessment_Category

part of: Recruiting_Assessment_Category_Response_Data
Recruiting Assessment Category Response Container
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Assessment_Category_Reference  Recruiting_Assessment_CategoryObject  [0..1]  Recruiting Assessment Category Refernce   
Recruiting_Assessment_Category_Data  Recruiting_Assessment_Category_Data  [0..*]  Container for Assessment Category Data   
top
 

Recruiting_Assessment_Category_Data

part of: Recruiting_Assessment_Category
Container for Assessment Category Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [1..1]  Reference ID 
Validation Description
Enter a unique ID. [ID] is already in use.   
 
Assessment_Category_Name  string  [1..1]  Assessment Category Name 
Validation Description
Enter another Recruiting Assessment Category Name because [Name] is already in use   
 
Description  string  [0..1]  Assessment Category Description   
Inactive  boolean  [0..1]  Inactive   
top
 

Recruiting_Assessment_CategoryReferenceEnumeration

part of: Recruiting_Assessment_CategoryObjectID
Base Type
string
top