Service Directory > v31.2 > Human_Resources > Get_Committee_Classification_Groups
 

Operation: Get_Committee_Classification_Groups

This operation retrieves Committee Classification Groups


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

Request element used to retrieve Committee Classification Groups and their data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Committee_Classification_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of a Committee Classification Group and its associated data.   
Request_Criteria [Choice]   Committee_Classification_Group_Request_Criteria  [0..1]  Committee Classification Group Request Criteria   
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  Committee_Classification_Group_Response_Group  [0..1]  Committee Classification Group Response Group.   
top
 

Response Element: Get_Committee_Classification_Groups_Response

Response element containing an instances of committee classification group and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Committee_Classification_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of a Committee Classification Group and its associated data.   
Request_Criteria  Committee_Classification_Group_Request_Criteria  [0..1]  Committee Classification Group Request Criteria   
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  Committee_Classification_Group_Response_Group  [0..1]  Committee Classification Group Response Group   
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  Committee_Classification_Group_Response_Data  [0..1]  Committee Classification Group Response Data   
top
 

Committee_Classification_Group_Request_References

part of: Get_Committee_Classification_Groups_Request, Get_Committee_Classification_Groups_Response
Utilize the Request References element to retrieve a specific instance(s) of a Committee Classification Group and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Committee_Classification_Group_Reference  Committee_Classification_GroupObject  [1..*]  Unique Reference to the Committee Classification Group. Used to identify the Committee Classification Group to update. Leave blank on an Add.   
top
 

Committee_Classification_GroupObject

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

Committee_Classification_GroupObjectID

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

part of: Get_Committee_Classification_Groups_Request, Get_Committee_Classification_Groups_Response
Committee Classification Group Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Committee_Classification_Groups_Request, Get_Committee_Classification_Groups_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_Classification_Group_Response_Group

part of: Get_Committee_Classification_Groups_Request, Get_Committee_Classification_Groups_Response
Committee Classification Group 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_Classification_Groups_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_Classification_Group_Response_Data

part of: Get_Committee_Classification_Groups_Response
Documentation Response element containing an instance of a Committee Classification Group and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Committee_Classification_Group  Committee_Classification_Group  [0..*]  Contains the data for a Committee Classification Group.   
top
 

Committee_Classification_Group

part of: Committee_Classification_Group_Response_Data
Contains the data for a Committee Classification Group.
 
Parameter name Type/Value Cardinality Description Validations
Committee_Classification_Group_Reference  Committee_Classification_GroupObject  [0..1]  Unique Reference to the Committee Classification Group.   
Committee_Classification_Group_Data  Committee_Classification_Group_Data  [0..*]  Committee Classification Group Data   
top
 

Committee_Classification_Group_Data

part of: Committee_Classification_Group
Data Committee Classification Group
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique Identifier for the committee classification group. If not entered, one will be generated.   
Name  string  [1..1]  Committee Classification Group Name. Required for add. 
Validation Description
Enter a unique Classification Group Name. The one you entered already exists.   
 
Inactive  boolean  [0..1]  A boolean flag to set the committee classification group inactive. 
Validation Description
You can't deactivate this Classification Group, since it contains active Classifications.   
You can't deactivate this Classification Group, since it contains active Classifications.   
 
Included_Classification_Reference  Committee_ClassificationObject  [0..*]  Included classifications for classification group   
top
 

Committee_ClassificationObject

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

Committee_ClassificationObjectID

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

part of: Committee_Classification_GroupObjectID
Base Type
string
top
 

Committee_ClassificationReferenceEnumeration

part of: Committee_ClassificationObjectID
Base Type
string
top