Service Directory > v31.2 > Staffing > Get_Job_Classification_Groups
 

Operation: Get_Job_Classification_Groups

Returns job classification group 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_Job_Classification_Groups_Request

Request Element for Get Job Classification
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Job_Classification_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Job Classification Group 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_Group  Job_Classification_Group_Response_Group  [0..1]  Get Job Classification Group Response Group   
top
 

Response Element: Get_Job_Classification_Groups_Response

Response Element for Get Job Classification Groups
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Job_Classification_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Job Classification Group 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_Group  Job_Classification_Group_Response_Group  [0..1]  Get Job 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  Job_Classification_Group_Response_Data  [0..1]  Element containing the Job Classification Group response data   
top
 

Job_Classification_Group_Request_References

part of: Get_Job_Classification_Groups_Request, Get_Job_Classification_Groups_Response
Utilize the Request References element to retrieve a specific instance(s) of Job Classification Group and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Job_Classification_Group_Reference  Job_Classification_GroupObject  [1..*]  A unique identifier used to reference a Job Classification Group.   
top
 

Job_Classification_GroupObject

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

Job_Classification_GroupObjectID

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

Response_Filter

part of: Get_Job_Classification_Groups_Request, Get_Job_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
 

Job_Classification_Group_Response_Group

part of: Get_Job_Classification_Groups_Request, Get_Job_Classification_Groups_Response
Get Job Classification Group Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
Include_Job_Classifications  boolean  [0..1]  A boolean attribute to indicate whether to include Job Classifications within a Job Classification Group in the WS response. When the boolean is set to 0 or false none of the Job Classifications will be returned. The default value is 1 or true.   
top
 

Response_Results

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

Job_Classification_Group_Response_Data

part of: Get_Job_Classification_Groups_Response
Element containing the Job Classification Group response data
 
Parameter name Type/Value Cardinality Description Validations
Job_Classification_Group  Job_Classification_Group_New  [0..*]  Encapsulating element containing all Job Classification Group data.   
top
 

Job_Classification_Group_New

part of: Job_Classification_Group_Response_Data
Response element containing an instance of Job Classification Group and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
@As_Of_Date  date  [1..1]  Defines the As Of Date to be used for any application effective dated data within the Workday system. For "Request" elements, the "As Of Date" determines what data is to be used within search logic or returned in a response. For "Response" elements, this element will echo "As Of Date" entered in the "Request" element or the default "As Of Date" if omitted..   
@As_Of_Moment  dateTime  [1..1]  Defines the latest moment (e.g. datetime) data was entered into the Workday system. For "Request" elements, the "As Of Moment" determines what data is to be used within search logic or returned in a response. For "Response" elements, this element will echo "As Of Moment" entered in the "Request" element or the default "As Of Moment" if omitted.   
Job_Classification_Group_Reference  Job_Classification_GroupObject  [0..1]  A unique identifier for the Job Classification Group.   
Job_Classification_Group_Name_Data  Job_Classification_Group_Reference_Data  [0..*]  Encapsulating element containing Job Classification Group data.   
Job_Classification_Group_Data  Job_Classification_Group_Data  [0..*]  Contains the detailed information about a Job Classification Group.   
top
 

Job_Classification_Group_Reference_Data

part of: Job_Classification_Group_New
A unique identifier used to reference a Job Classification Group.
 
Parameter name Type/Value Cardinality Description Validations
Job_Classification_Group_Name  string  [1..1]  The name of a Job Classification Group.   
top
 

Job_Classification_Group_Data

part of: Job_Classification_Group_New
Job Classification Group Data Element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Job Classification Group ID   
Effective_Date  date  [0..1]  Effective Date. A new effective-dated organization name is automatically created if any attributes used for organization name are different as of specified effective date which include: Organization Name, Organization Code, and Include 'xx' in Name booleans. 
Validation Description
The effective date of the change [date] cannot be earlier than the earliest effective date [early].   
 
Job_Classification_Group_Name  string  [0..1]  The name of the Job Classification Group. 
Validation Description
Name is required.   
 
Global_Setup_Data_Mapping_Reference  Global_Setup_Data_MappingObject  [0..1]  Metadata value the job classification group maps to.   
Location_Reference  Location_ContextObject  [0..1]  Location Reference. Reference to a Country or Country Region.   
Inactive  boolean  [0..1]  Inactive Flag.   
Job_Classification  Job_Classification  [0..*]  Job Classification Element 
Validation Description
Job Classification Data needs to be included unless Delete is True.   
Job Classification Data cannot be included if Delete is True.   
If Delete is True, a Job Classification Reference must be included.   
 
top
 

Global_Setup_Data_MappingObject

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

Global_Setup_Data_MappingObjectID

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

Location_ContextObject

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

Location_ContextObjectID

part of: Location_ContextObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Region_ID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_ID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-2_Code  [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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [1..1]  The unique identifier type of a parent object   
top
 

Job_Classification

part of: Job_Classification_Group_Data
Job Classification Group Data
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted. 
Validation Description
Job Classification cannot be deleted because it is in use. Please set it to inactive.   
 
Job_Classification_Reference  Job_ClassificationObject  [0..1]  A unique identifier use to reference a Job Classification.   
Job_Classification_Data  Job_Classification_Data  [0..1]  Job Classification Data   
Validation Description
Job Classification Data needs to be included unless Delete is True.   
Job Classification Data cannot be included if Delete is True.   
If Delete is True, a Job Classification Reference must be included.   
top
 

Job_ClassificationObject

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

Job_ClassificationObjectID

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

Job_Classification_Data

part of: Job_Classification
Job Classification Data Element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique Identifier for a Job Classification. On a new entry, this will become the Reference ID. When updating an existing Job Classification, you can enter a new value here to change the Reference ID.   
Job_Classification_ID  string  [0..1]  A text value for the Job Classification ID. This is usually defined by the outside agency that sets the Job Classification in the group. It does not need to be unique. 
Validation Description
Identifier ID is Required   
 
Description  string  [0..1]  Job Classification Description   
Job_Classification_Mapping_ID_Reference  Unique_IdentifierObject  [0..1]  The Workday Owned metadata value the job classification maps to   
Inactive  boolean  [0..1]  Inactive Flag.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Job_Classification_GroupReferenceEnumeration

part of: Job_Classification_GroupObjectID
Base Type
string
top
 

Global_Setup_Data_MappingReferenceEnumeration

part of: Global_Setup_Data_MappingObjectID
Base Type
string
top
 

Location_ContextReferenceEnumeration

part of: Location_ContextObjectID
Base Type
string
top
 

Base Type
string

top
 

Job_ClassificationReferenceEnumeration

part of: Job_ClassificationObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top