Service Directory > v32.1 > Human_Resources > Get_Assign_Establishment_Events
 

Operation: Get_Assign_Establishment_Events

Get an Assign Establishment event


@ - 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_Assign_Establishment_Events_Request

Get Assign Establishment Events Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Assign_Establishment_Event_Request_References  [0..1]  Assign Establishment Event Request References   
Request_Criteria [Choice]   Assign_Establishment_Event_Request_Criteria  [0..1]  Assign Establishment Event Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Assign_Establishment_Event_Response_Group  [0..1]  Assign Establishment Event Response Group   
top
 

Response Element: Get_Assign_Establishment_Events_Response

Get Assign Establishment Events Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Assign_Establishment_Event_Request_References  [0..1]  Assign Establishment Event Request References   
Request_Criteria  Assign_Establishment_Event_Request_Criteria  [0..1]  Assign Establishment Event 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  Assign_Establishment_Event_Response_Group  [0..1]  Assign Establishment Event 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  Assign_Establishment_Event_Response_Data  [0..1]  Get Assign Establishment Events Response Data   
top
 

Assign_Establishment_Event_Request_References

part of: Get_Assign_Establishment_Events_Request, Get_Assign_Establishment_Events_Response
Assign Establishment Event Request References
 
Parameter name Type/Value Cardinality Description Validations
Workers_Secured_by_Transaction_Reference  WorkerObject  [1..*]  Workers Secured by Transaction Reference   
top
 

WorkerObject

part of: Assign_Establishment_Data, Assign_Establishment_Event, Assign_Establishment_Event_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  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
 

Assign_Establishment_Event_Request_Criteria

part of: Get_Assign_Establishment_Events_Request, Get_Assign_Establishment_Events_Response
Assign Establishment Event Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Assign_Establishment_Events_Request, Get_Assign_Establishment_Events_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
 

Assign_Establishment_Event_Response_Group

part of: Get_Assign_Establishment_Events_Request, Get_Assign_Establishment_Events_Response
Assign Establishment Event Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Assign_Establishment_Event_Response_Data

part of: Get_Assign_Establishment_Events_Response
Get Assign Establishment Events Response Data
 
Parameter name Type/Value Cardinality Description Validations
Assign_Establishment  Assign_Establishment_Event  [0..*]  Assign Establishment Event   
top
 

Assign_Establishment_Event

part of: Assign_Establishment_Event_Response_Data
Assign Establishment Event
 
Parameter name Type/Value Cardinality Description Validations
Workers_Secured_by_Transaction_Reference  WorkerObject  [0..*]  Workers Secured by Transaction Reference   
Assign_Establishment_Data  Assign_Establishment_Data  [0..*]  The request element containing all necessary information to manually assign an establishment to a worker position 
Validation Description
Specified position is not valid for establishment assignment. Please check Country Establishment Settings.   
Worker does not have a valid position for establishment assignment as of date provided.   
Selected Establishment is not available for the selected Date.   
Establishments can not be assigned to Terminated Workers   
The selected Establishment is Inactive as of the date provided   
You can not Assign an Establishment for this Worker until you have completed the pending Assign Establishment event.   
Establishment cannot be assigned to contingent workers for [Country]   
 
top
 

Assign_Establishment_Data

part of: Assign_Establishment_Event
The request element containing all necessary information to manually assign an establishment to a worker position
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  The date upon which this establishment assignment becomes active for the specified worker position   
Worker_Reference  WorkerObject  [1..1]  The worker who is to be assigned the specified establishment on the specified date   
Position_Reference  Position_ElementObject  [1..1]  The position of the worker for which the establishment is taking effect   
Establishment_Reference  EstablishmentObject  [1..1]  The establishment we wish to assign to the specified worker position   
Validation Description
Specified position is not valid for establishment assignment. Please check Country Establishment Settings.   
Worker does not have a valid position for establishment assignment as of date provided.   
Selected Establishment is not available for the selected Date.   
Establishments can not be assigned to Terminated Workers   
The selected Establishment is Inactive as of the date provided   
You can not Assign an Establishment for this Worker until you have completed the pending Assign Establishment event.   
Establishment cannot be assigned to contingent workers for [Country]   
top
 

Position_ElementObject

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

Position_ElementObjectID

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

EstablishmentObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

EstablishmentReferenceEnumeration

part of: EstablishmentObjectID
Base Type
string
top