Service Directory > v31.2 > Human_Resources > Get_Previous_System_Job_History
 

Operation: Get_Previous_System_Job_History

Returns a worker's job or position history imported from a previous system; that is, the user's system prior to migrating to Workday.


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

Request element used to return a worker's job/position history loaded from a previous system. If no worker reference is requested, then all workers with previous system job data will be returned.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worker_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Worker 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  Worker_Response_Group_for_Reference  [0..1]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then all groups will be returned. If the Response Group element is returned, you can select which sections of data to include in the response.   
top
 

Response Element: Get_Previous_System_Job_History_Response

Response element containing the instances of workers and their previous job history.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worker_Request_References  [0..*]  Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.   
Response_Filter  Response_Filter  [0..*]  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..*]  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_Group  Worker_Response_Group_for_Reference  [0..*]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then all groups will be returned. If the Response Group element is returned, you can select which sections of data to include in the response.   
Response_Data  Previous_System_Job_History_Response_Data  [0..*]  Contains each Worker and their job history from a previous system.   
top
 

Worker_Request_References

part of: Get_Previous_System_Job_History_Request, Get_Previous_System_Job_History_Response
Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
@Skip_Non_Existing_Instances  boolean  [1..1]     
@Ignore_Invalid_References  boolean  [1..1]     
Worker_Reference  WorkerObject  [1..*]  A reference to the ID of the worker. The ID consists of a type attribute, which should be set to "Employee_ID" or "Contingent_Worker_ID", and a value attribute, such as "04345". If Skip Non Existing Instances value is set to true. When a reference id value that does not meet the entry date criteria is passed, the non existent reference id will be ignored.   
top
 

WorkerObject

part of: Previous_System_Job_History, Worker_Request_References, Previous_System_Job_History_Get_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  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
 

Response_Filter

part of: Get_Previous_System_Job_History_Request, Get_Previous_System_Job_History_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
 

Worker_Response_Group_for_Reference

part of: Get_Previous_System_Job_History_Request, Get_Previous_System_Job_History_Response
The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then all groups will be returned. If the Response Group element is returned, you can select which sections of data to include in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if the Reference to the Worker should be included in the response at the Previous_System_Job_History element level. It is always returned in the Previous_System_Job_History_Data level.   
top
 

Response_Results

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

Previous_System_Job_History_Response_Data

part of: Get_Previous_System_Job_History_Response
Contains each Worker and their job history from a previous system.
 
Parameter name Type/Value Cardinality Description Validations
Previous_System_Job_History  Previous_System_Job_History_Get_Data  [0..*]  Container for a Worker and the Previous System Job History data.   
top
 

Previous_System_Job_History_Get_Data

part of: Previous_System_Job_History_Response_Data
Container for a Worker and the Previous System Job History data.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  A reference to the ID of the worker. The ID consists of a type attribute, which should be set to "Employee_ID" or "Contingent_Worker_ID", and a value attribute, such as "04345". If Skip Non Existing Instances value is set to true. When a reference id value that does not meet the entry date criteria is passed, the non existent reference id will be ignored.   
Previous_System_Job_History_Data  Previous_System_Job_History  [0..*]  Contains the Data for adding, updating or deleting a previous system job history entry for a worker.   
top
 

Previous_System_Job_History

part of: Previous_System_Job_History_Get_Data
Contains the Data for adding, updating or deleting a previous system job history entry for a worker.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Unique Identifier for a worker (Employee or Contingent Worker).   
Previous_System_Job_History  Previous_System_Job_History_Data  [1..*]  Container for defining whether a previous system job history entry is being added, updated or deleted. 
Validation Description
Previous System Job History Detail Data element is required (unless deleting an entry).   
Add Only is True but the reference ID is already in use. Verify that you are sending the correct ID - or set Add Only to false if you want to update the existing entry. ID: [ID] In Use on: [Used]   
 
top
 

Previous_System_Job_History_Data

part of: Previous_System_Job_History
Container for defining whether a previous system job history entry is being added, updated or deleted.
 
Parameter name Type/Value Cardinality Description Validations
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted. 
Validation Description
Add Only and Delete cannot both be true.   
 
Previous_System_Job_History_Reference  Job_Previous_System_HistoryObject  [0..1]  Unique Identifier to a Previous System Job History entry. Required if you are deleting or updating an existing entry. Leave blank on an Add. 
Validation Description
Previous System Job History Reference is Required if Delete flag is True.   
The Previous System Job History Reference submitted is in use for a different worker. Previous System Job History Reference: [Job] Worker Submitted: [Worker] Worker in use: [OtherWorker]   
 
Previous_System_Job_History_Detail_Data  Previous_System_Job_History_Detail_Data  [0..1]  Detail data for a Previous System Job History entry.   
Validation Description
Previous System Job History Detail Data element is required (unless deleting an entry).   
Add Only is True but the reference ID is already in use. Verify that you are sending the correct ID - or set Add Only to false if you want to update the existing entry. ID: [ID] In Use on: [Used]   
top
 

Job_Previous_System_HistoryObject

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

Job_Previous_System_HistoryObjectID

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

Previous_System_Job_History_Detail_Data

part of: Previous_System_Job_History_Data
Detail data for a Previous System Job History entry.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique identifier for a Previous System Job History entry. This can be entered here on an add to set the reference id to a customer determined value or left blank and a default value will be saved. If you are updating an existing entry, entering a value here will change the reference id.   
Worker_History_Name  string  [0..1]  Name to identify the Previous System Job History. This does not have to be unique. During an update, if no value is sent then the existing value will be kept. Required on an Add. 
Validation Description
Worker History Name is required.   
 
Action_Date  date  [0..1]  Date of the Previous System Job entry. During an update, if no value is sent, then the existing date will be kept. Required on an Add. 
Validation Description
Action Date is required.   
 
Reason  string  [0..1]  Reason for the Previous System Job Entry. During an update, if no value is sent then the existing value will be kept. Required on an Add. 
Validation Description
The Reason is required.   
 
Description  string  [0..1]  Free Form Description for the Previous System Job Entry. During an update, if no valie is sent then the existing value will be kept.   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Job_Previous_System_HistoryReferenceEnumeration

part of: Job_Previous_System_HistoryObjectID
Base Type
string
top