Service Directory > v31.2 > Human_Resources > Get_Establishments
 

Operation: Get_Establishments

Get Establishments 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_Establishments_Request

Get Establishments Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Establishment_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Establishment_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Establishments_Response

Get Establishments Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Establishment_Request_References  [0..1]  Establishment References   
Request_Criteria  Establishment_Request_Criteria  [0..1]  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_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  Establishment_Response_Data  [0..1]  Response Data   
top
 

Establishment_Request_References

part of: Get_Establishments_Request, Get_Establishments_Response
Establishment References
 
Parameter name Type/Value Cardinality Description Validations
Establishment_Reference  EstablishmentObject  [1..*]  Establishment References   
top
 

EstablishmentObject

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

EstablishmentObjectID

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

Establishment_Request_Criteria

part of: Get_Establishments_Request, Get_Establishments_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [1..1]  Country for Establishments   
top
 

CountryObject

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

CountryObjectID

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

Response_Results

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

Establishment_Response_Data

part of: Get_Establishments_Response
Response Data
 
Parameter name Type/Value Cardinality Description Validations
Establishment  Establishment  [0..*]  Establishment Data   
top
 

Establishment

part of: Establishment_Response_Data
Establishments Data wrapper
 
Parameter name Type/Value Cardinality Description Validations
Establishment_Reference  EstablishmentObject  [0..1]  Establishment Reference   
Establishment_Data  Establishment_Data  [0..*]  Establishment Data wrapper 
Validation Description
Once an Establishment has been created, the Country may not be changed.   
Establishment Number and Country are required when creating a new Establishment. Neither can be changed when Updating an Establishment   
The Country Reference provided does not have Establishment Settings defined.   
All Locations provided must exist within the provided Country Reference   
All Locations provided must exist within the referenced Establishment's Country   
All Legal Entities provided must be of the same Legal Entity Type as defined in the Establishment Settings for provided Country Reference   
All Legal Entities provided must be of the same Legal Entity Type as defined in the Establishment Settings for related Establishment   
Use either Establishment Reference to Update an Establishment, or Establishment Number to Create a new Establishment.   
Use either Establishment Reference to Update an Establishment, or Establishment Number to Create a new Establishment.   
DUNS is not a value which is tracked for this Country's Establishment Settings. Please review   
EEO is not a value which is tracked for this Country's Establishment Settings. Please review   
Industry Code is not a value which is tracked for this Country's Establishment Settings. Please review   
SIRET is not a value which is tracked for this Country's Establishment Settings. Please review   
VETS is not a value which is tracked for this Country's Establishment Settings. Please review   
Establishment Headquarters is not a value which is tracked for this Country's Establishment Settings. Please review   
That Establishment Number is already in use for the specified Country. Please choose another.   
CCC is not a value which is tracked for this Country's Establishment Settings. Please review   
 
top
 

Establishment_Data

part of: Establishment
Establishment Data wrapper
 
Parameter name Type/Value Cardinality Description Validations
Establishment_Number  string  [0..1]  Establishment Number   
ID  string  [0..1]  The ID for Establishment.   
Country_Reference  CountryObject  [0..1]  Establish for Country   
Effective_Date  date  [1..1]  Effective Date of Establishment Creation/Edit   
Establishment_Name  string  [0..1]  Establishment Name   
Inactive  boolean  [0..1]  Inactive flag   
Location_Reference  LocationObject  [1..*]  Location(s) for Establishment   
Establishment_Legal_Entity_Reference  Establishment_Legal_EntityObject  [1..*]  Legal Entities for Establishment   
CCC_Text  string  [0..1]  CCC #   
DUNS_Text  string  [0..1]  Duns #   
EEO_Text  string  [0..1]  EEO #   
Industry_Code_Text  string  [0..1]  Industry Code #   
SIRET_Text  string  [0..1]  SIRET #   
VETS_Text  string  [0..1]  VETS #   
Establishment_Headquarters  boolean  [0..1]  Headquarters flag   
Validation Description
Once an Establishment has been created, the Country may not be changed.   
Establishment Number and Country are required when creating a new Establishment. Neither can be changed when Updating an Establishment   
The Country Reference provided does not have Establishment Settings defined.   
All Locations provided must exist within the provided Country Reference   
All Locations provided must exist within the referenced Establishment's Country   
All Legal Entities provided must be of the same Legal Entity Type as defined in the Establishment Settings for provided Country Reference   
All Legal Entities provided must be of the same Legal Entity Type as defined in the Establishment Settings for related Establishment   
Use either Establishment Reference to Update an Establishment, or Establishment Number to Create a new Establishment.   
Use either Establishment Reference to Update an Establishment, or Establishment Number to Create a new Establishment.   
DUNS is not a value which is tracked for this Country's Establishment Settings. Please review   
EEO is not a value which is tracked for this Country's Establishment Settings. Please review   
Industry Code is not a value which is tracked for this Country's Establishment Settings. Please review   
SIRET is not a value which is tracked for this Country's Establishment Settings. Please review   
VETS is not a value which is tracked for this Country's Establishment Settings. Please review   
Establishment Headquarters is not a value which is tracked for this Country's Establishment Settings. Please review   
That Establishment Number is already in use for the specified Country. Please choose another.   
CCC is not a value which is tracked for this Country's Establishment Settings. Please review   
top
 

LocationObject

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

Establishment_Legal_EntityObject

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

Establishment_Legal_EntityObjectID

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

EstablishmentReferenceEnumeration

part of: EstablishmentObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Establishment_Legal_EntityReferenceEnumeration

part of: Establishment_Legal_EntityObjectID
Base Type
string
top