Service Directory > v25.1 > Human_Resources > Find_Worker
 

Operation: Find_Worker DEPRECATED

DEPRECATED: The functionality within this operation has been replaced with the "Get_Workers" operation. This operation responds with a set of references to Workers (e.g. Employees and Contingent Workers) that match the criteria specified in the request element.


@ - 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: Worker_Find

Utilize the following criteria options to search for Workers within the Workday system. The Worker references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criterium that is populated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
As_Of_Date  date  [0..1]  Defines the As Of Date to be used for any application effective dated data within the Workday system. For "Find" operations, the "As Of Date" determines what data to be used within the search logic. For "Get" operations, the response element will only include data that is the most effective as of the "As Of Date".   
As_Of_Moment  dateTime  [0..1]  Defines the latest moment (e.g. datetime) data was entered into the Workday system. For "Find" operations, the "As Of Moment" determines what data to be used within the search logic. For "Get" operations, the response element will only include data entered into Workday before the "As Of Moment".   
Exclude_Terminated_Workers  boolean  [0..1]  If specified, only Active Workers (or Workers on Leave) will be returned by search.   
Comparison_Data  Comparison_Data  [0..1]  Root node for comparison data. This functionality allows for the retrieval of objects that have a change in data between two timeframes (From/Through). Based on the following criteria, the system will abstractly create one or more "From" and "Through" elements for each object to be returned in this operation, compare them, and if there is a difference, respond with a reference to that object. 
Validation Description
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
At least 1 Web Service Operation or Class Report Field needs to be supplied to use the Comparison Data functionality.  At least 1 Web Service Operation or Class Report Field needs to be supplied to use the Comparison Data functionality. 
 
top
 

Response Element: Worker_References

Set of Worker Reference elements.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@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..   
Worker_Reference  Worker_Reference_WWS  [0..*]  Reference element representing an object within the Workday system. The sub-elements and attributes within this element are used to return one and only one instance of the identifying object.   
top
 

Comparison_Data

part of: Worker_Find
Element containing criteria to be used within a Comparison routine.
 
Parameter name Type/Value Cardinality Description Validations
Updated_From  dateTime  [0..1]  For the creation of the abstract "From" snapshot, defines the latest moment (e.g. datetime) data was entered into the Workday system.   
Updated_Through  dateTime  [0..1]  For the creation of the abstract "Through" snapshot, defines the latest moment (e.g. datetime) data was entered into the Workday system.   
Effective_From  date  [0..1]  For the creation of the abstract "From" snapshot, defines the As Of Date to be used for any application effective dated data within the Workday system.   
Effective_Through  date  [0..1]  For the creation of the abstract "Through" snapshot, defines the As Of Date to be used for any application effective dated data within the Workday system.   
Web_Service_Operation_References  Web_Service_Operation_References  [0..1]  Root node for set of Web Service Operation References. When the Comparison routine creates an abstract element, it will build data in the structure of the response element from each of the referenced Web Service Operations.   
Class_Report_Field_References  Class_Report_Field_References  [0..1]  Root node for set of Class Report Field References. When the Comparison routine creates an abstract element, it will build data in the structure (attribute or instance set) of the Class Report Field.   
Validation Description
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
At least 1 Web Service Operation or Class Report Field needs to be supplied to use the Comparison Data functionality.  At least 1 Web Service Operation or Class Report Field needs to be supplied to use the Comparison Data functionality. 
top
 

Web_Service_Operation_References

part of: Comparison_Data
Set of Web Service Operation Reference elements.
 
Parameter name Type/Value Cardinality Description Validations
Web_Service_Operation_Reference  Web_Service_Operation_Reference_Data  [1..*]  Reference element representing an object within the Workday system. The sub-elements and attributes within this element are used to return one and only one instance of the identifying object.   
top
 

Web_Service_Operation_Reference_Data

part of: Web_Service_Operation_References
Reference element representing a unique instance of Web Service Operation.
 
Parameter name Type/Value Cardinality Description Validations
Web_Service_Name  string  [1..1]  Text attribute representing Name of a Web Service. 
Validation Description
Web Service does not exist for Web Service XML name!   
 
Web_Service_Operation_Name  string  [1..1]  Text attribute representing Name of a Web Service Operation. 
Validation Description
Web Service Operation does not exist for Web Service and Operation XML names!   
 
top
 

Class_Report_Field_References

part of: Comparison_Data
Set of Class Report Field Reference elements.
 
Parameter name Type/Value Cardinality Description Validations
Class_Report_Field_Reference  Class_Report_Field_Reference  [1..*]  Reference element representing an object within the Workday system. The sub-elements and attributes within this element are used to return one and only one instance of the identifying object.   
top
 

Class_Report_Field_Reference

part of: Class_Report_Field_References
Reference element representing a unique instance of Class Report Field. Only attribute-based CRFs should be used for comparing data and not object-based CRFs in order to return data-level changes in the system.
 
Parameter name Type/Value Cardinality Description Validations
Class_Report_Field_Name  string  [1..1]  Text attribute representing Name of a Class Report Field. 
Validation Description
Class Report Field does not exist for Class Report Field Name!   
 
top
 

Worker_Reference_WWS

part of: Worker_References
Reference element representing a unique instance of Worker (e.g. Employee or Contingent Worker).
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference [Choice]   Employee_Reference  [1..1]  Reference element representing a unique instance of Employee. 
Validation Description
Employee Reference Integration ID does not exist!  A valid instance of Employee must exist for the given Integration ID Reference. 
 
Contingent_Worker_Reference [Choice]   Contingent_Worker_Reference_Data  [1..1]  Reference element representing a unique instance of Contingent Worker. 
Validation Description
Contingent Worker Reference Integration ID does not exist!  A valid instance of Contingent Worker must exist for the given Integration ID Reference. 
 
Worker_ID_Reference  WorkerObject  [0..1]  Contains a reference to a worker, which can be used in the request of the Get Workers web service.   
top
 

Employee_Reference

part of: Worker_Reference_WWS
Reference element representing a unique instance of Employee.
 
Parameter name Type/Value Cardinality Description Validations
Integration_ID_Reference  External_Integration_ID_Reference_Data  [1..1]  Integration ID reference is used as a unique identifier for integratable objects in the Workday system.   
Validation Description
Employee Reference Integration ID does not exist!  A valid instance of Employee must exist for the given Integration ID Reference. 
top
 

External_Integration_ID_Reference_Data

part of: Employee_Reference, Contingent_Worker_Reference_Data
Integration ID reference is used as a unique identifier for integratable objects in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display name inside the Workday system.   
ID  ID  [1..1]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

ID

part of: External_Integration_ID_Reference_Data
External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@System_ID  string  [1..1]  Integration system identifier, part of a two part key (including the text value of the ID element) that uniquely identify integratable object. 
Validation Description
Integration System ID does not exist.  A valid instance of Integration ID must exist for the given System ID. 
 
top
 

Contingent_Worker_Reference_Data

part of: Worker_Reference_WWS
Reference element representing a unique instance of Contingent Worker.
 
Parameter name Type/Value Cardinality Description Validations
Integration_ID_Reference  External_Integration_ID_Reference_Data  [1..1]  Integration ID reference is used as a unique identifier for integratable objects in the Workday system.   
Validation Description
Contingent Worker Reference Integration ID does not exist!  A valid instance of Contingent Worker must exist for the given Integration ID Reference. 
top
 

WorkerObject

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

WorkerObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top