Service Directory > v31.2 > Human_Resources > Get_Committee_Membership_Types
 

Operation: Get_Committee_Membership_Types

This operation retrieves Committee Member 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_Membership_Types_Request

Get Committee Membership Types Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Committee_Membership_Type_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of a Committee Member Type and its associated data   
Request_Criteria [Choice]   Committee_Membership_Type_Request_Criteria  [0..1]  Committee Membership Type 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_Membership_Type_Response_Group  [0..1]  Committee Membership Type Response Group   
top
 

Response Element: Get_Committee_Membership_Types_Response

Response element containing an instances of committee membership type and their associated data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Committee_Membership_Type_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of a Committee member Type and its associated data.   
Request_Criteria  Committee_Membership_Type_Request_Criteria  [0..1]  Committee Member 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_Membership_Type_Response_Group  [0..1]  Committee Member Type Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Committee_Membership_Type_Response_Data  [0..1]  Committee Member Type Response Data   
top
 

Committee_Membership_Type_Request_References

part of: Get_Committee_Membership_Types_Request, Get_Committee_Membership_Types_Response
Utilize the Request References element to retrieve a specific instance(s) of a Committee Member Type and its associated data
 
Parameter name Type/Value Cardinality Description Validations
Committee_Membership_Type_Reference  Committee_Membership_TypeObject  [1..*]  Utilize the Request References element to retrieve a specific instance(s) of a Committee Member Type and its associated data.   
top
 

Committee_Membership_TypeObject

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

Committee_Membership_TypeObjectID

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

part of: Get_Committee_Membership_Types_Request, Get_Committee_Membership_Types_Response
Committee Membership Type Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Committee_Membership_Types_Request, Get_Committee_Membership_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_Membership_Type_Response_Group

part of: Get_Committee_Membership_Types_Request, Get_Committee_Membership_Types_Response
Committee Membership 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_Membership_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_Membership_Type_Response_Data

part of: Get_Committee_Membership_Types_Response
Response element containing an instances of committee member type and their associated data
 
Parameter name Type/Value Cardinality Description Validations
Committee_Membership_Type  Committee_Membership_Type  [0..*]  Contains the data for a Committee Member Type   
top
 

Committee_Membership_Type

part of: Committee_Membership_Type_Response_Data
Contains the data for a Committee Membership Type
 
Parameter name Type/Value Cardinality Description Validations
Committee_Membership_Type_Reference  Committee_Membership_TypeObject  [0..1]  Unique Reference to the Committee Member Type   
Committee_Membership_Type_Data  Committee_Membership_Type_Data  [0..*]  Committee Member Type Data   
top
 

Committee_Membership_Type_Data

part of: Committee_Membership_Type
Data for Committee Membership Type
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique Identifier for the committee member type. If not entered, one will be generated.   
Name  string  [1..1]  Committee Member Type Name. Required for add.   
Inactive  boolean  [0..1]  A boolean flag to disable this Committee Membership Type from being assigned to any new membership profiles. Note: This Committee Membership Type still appears in historical reporting.   
top
 

Committee_Membership_TypeReferenceEnumeration

part of: Committee_Membership_TypeObjectID
Base Type
string
top