Service Directory > v31.2 > Human_Resources > Find_Business_Site
 

Operation: Find_Business_Site DEPRECATED

DEPRECATED: This web service operation is deprecated. Please use the Get Locations web service operation instead. This operation responds with a set of references to Business Sites 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: Business_Site_Find

Utilize the following criteria options to search for Locations within the Workday system. The Location references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criteria that is populated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Location_Name  string  [0..1]  If specified, this search criterium will return those references with an exact match. The search index used to query on this value is not case-sensitive.   
top
 

Response Element: Business_Site_References

 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Location_Reference  Location_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. 
Validation Description
Location Reference does not exist.  A valid instance of Location must exist for the given Integration ID Reference. 
Only Integration ID Reference or Location ID Reference is allowed for the Location Reference, but both are not allowed.  Only Integration ID Reference or Location ID Reference is allowed for the Location Reference, but both are not allowed. 
 
top
 

Business_Site_References

Set of Location Reference elements.
 
Parameter name Type/Value Cardinality Description Validations
Location_Reference  Location_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. 
Validation Description
Location Reference does not exist.  A valid instance of Location must exist for the given Integration ID Reference. 
Only Integration ID Reference or Location ID Reference is allowed for the Location Reference, but both are not allowed.  Only Integration ID Reference or Location ID Reference is allowed for the Location Reference, but both are not allowed. 
 
top
 

Location_Reference_WWS

part of: Business_Site_References
Reference element representing a unique instance of Location.
 
Parameter name Type/Value Cardinality Description Validations
Integration_ID_Reference  External_Integration_ID_Reference_Data  [0..1]  Integration ID reference is used as a unique identifier for integratable objects in the Workday system.   
Location_ID_Reference  LocationObject  [0..1]  A reference to a location. 
Validation Description
Location must be of usage Business Site.  Location must be of usage Business Site. 
 
Validation Description
Location Reference does not exist.  A valid instance of Location must exist for the given Integration ID Reference. 
Only Integration ID Reference or Location ID Reference is allowed for the Location Reference, but both are not allowed.  Only Integration ID Reference or Location ID Reference is allowed for the Location Reference, but both are not allowed. 
top
 

External_Integration_ID_Reference_Data

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

LocationObject

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

LocationObjectID

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

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top