Service Directory > v31.2 > Human_Resources > Get_Committee_Types
 

Operation: Get_Committee_Types

This operation retrieves Committee Types


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

Get Committee Types Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Committee_Type_Request_References  [0..1]  Committee Type Request References   
Request_Criteria [Choice]   Committee_Type_Request_Criteria  [0..1]  Get Committee Types Request   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Committee_Type_Response_Group  [0..1]  Committee Type Response Group   
top
 

Response Element: Get_Committee_Types_Response

Committee Type Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Committee_Type_Request_References  [0..1]  Committee Type Response Data   
Request_Criteria  Committee_Type_Request_Criteria  [0..1]  Committee Type Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Committee_Type_Response_Group  [0..1]  Committee Type Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Committee_Type_Response_Data  [0..1]  Committee Type Response Data   
top
 

Committee_Type_Request_References

part of: Get_Committee_Types_Request, Get_Committee_Types_Response
Committee Type Request References
 
Parameter name Type/Value Cardinality Description Validations
Committee_Type_Reference  Committee_TypeObject  [1..*]  Committee Type Request References   
top
 

Committee_TypeObject

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

Committee_TypeObjectID

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

Committee_Type_Request_Criteria

part of: Get_Committee_Types_Request, Get_Committee_Types_Response
Committee Type Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Committee_Types_Request, Get_Committee_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
 

Committee_Type_Response_Group

part of: Get_Committee_Types_Request, Get_Committee_Types_Response
Committee Type Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

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

Committee_Type_Response_Data

part of: Get_Committee_Types_Response
Committee Type Response Data
 
Parameter name Type/Value Cardinality Description Validations
Committee_Type  Committee_Type  [0..*]  Committee Type   
top
 

Committee_Type

part of: Committee_Type_Response_Data
Committee Type
 
Parameter name Type/Value Cardinality Description Validations
Committee_Type_Reference  Committee_TypeObject  [0..1]  Unique Reference to a Committee Type   
Committee_Type_Data  Committee_Type_Data  [0..1]  Data for Committee Type   
top
 

Committee_Type_Data

part of: Committee_Type
Data for Committee Type
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique Identifier for the committee type. If not entered, one will be generated.   
Name  string  [1..1]  Committee Type Name. Required for add.   
Search_Committee  boolean  [0..1]  Search Committee 
Validation Description
You cannot change Search Committee to No. This Committee Type is in use by at least one committee with a related job requisition.   
 
Inactive  boolean  [0..1]  A boolean flag to set the committee type inactive.   
top
 

Committee_TypeReferenceEnumeration

part of: Committee_TypeObjectID
Base Type
string
top