Service Directory > v31.2 > Payroll > Get_ROE_History_Data
 

Operation: Get_ROE_History_Data

Return Canadian Record of Employment history data for a given Record of Employment.


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

Root element for the Request on the Get operation. Contains references, criteria, filter and response group for specifying which instances to return in the Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   ROE_History_Data_Request_References  [0..1]  The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.   
Request_Criteria [Choice]   ROE_History_Data_Request_Criteria  [0..1]  ROE History Data Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter Element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  ROE_History_Data_Response_Group  [0..1]  ROE History Data Response Group Element   
top
 

Response Element: Get_ROE_History_Data_Response

Get ROE Data History Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  ROE_History_Data_Request_References  [0..1]  The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.   
Request_Criteria  ROE_History_Data_Request_Criteria  [0..1]  ROE History Data Request Criteria Element   
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  ROE_History_Data_Response_Group  [0..1]  The Response Group allows the request to specify which data attributes should be returned in the Response, such as whether to include reference elements, attachments, etc.   
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  ROE_History_Data_Response_Data  [0..1]  ROE History Data Response Data element   
top
 

ROE_History_Data_Request_References

part of: Get_ROE_History_Data_Request, Get_ROE_History_Data_Response
The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.
 
Parameter name Type/Value Cardinality Description Validations
ROE_History_Data_Reference  Unique_IdentifierObject  [1..*]  ROE History Data Request Reference. Workset to be returned by Get Web Service   
top
 

Unique_IdentifierObject

part of: ROE_History_Data, ROE_History_Data_Request_References, ROE_History
 
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  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

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

ROE_History_Data_Request_Criteria

part of: Get_ROE_History_Data_Request, Get_ROE_History_Data_Response
ROE History Data Request Criteria Element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_ROE_History_Data_Request, Get_ROE_History_Data_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
 

ROE_History_Data_Response_Group

part of: Get_ROE_History_Data_Request, Get_ROE_History_Data_Response
The Response Group allows the request to specify which data attributes should be returned in the Response, such as whether to include reference elements, attachments, etc.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

ROE_History_Data_Response_Data

part of: Get_ROE_History_Data_Response
ROE History Data Response Data element
 
Parameter name Type/Value Cardinality Description Validations
ROE_History  ROE_History  [0..*]  ROE History Data Response   
top
 

ROE_History

part of: ROE_History_Data_Response_Data
ROE History element containing Payroll ROE instance and necessary data for ROE History
 
Parameter name Type/Value Cardinality Description Validations
Payroll_ROE_Data_Reference  Unique_IdentifierObject  [0..1]  Payroll ROE Data instance   
ROE_History_Data  ROE_History_Data  [0..*]  ROE History Data element containing attributes needed 
Validation Description
Payroll Reference Number is not valid for the specified company and issue date.   
 
top
 

ROE_History_Data

part of: ROE_History
ROE History Data element containing attributes needed
 
Parameter name Type/Value Cardinality Description Validations
Payroll_ROE_History_Data_Reference  Unique_IdentifierObject  [0..1]  Payroll ROE Data instance   
Company_Reference  CompanyObject  [1..1]  Company for Canada ROE History   
Worker_Reference  WorkerObject  [1..1]  Worker for ROE History   
Payroll_Reference_Number_Reference  Payroll_Reference_NumberObject  [1..1]  Payroll Reference Number   
Date_Issued  date  [1..1]  ROE Date Issued. Must be 8 characters in the format "DDMMYYYY". This is present when the ROE is issued.   
Serial_Number  string (9)   [0..1]  ROE Serial Number. Must be 9 characters. This is present when the ROE is Issued.   
Return_from_Leave_Date__Prior_to_Go_Live_  date  [0..1]  The Return From Leave date only applicable before the Workday Go Live date.   
Validation Description
Payroll Reference Number is not valid for the specified company and issue date.   
top
 

CompanyObject

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

CompanyObjectID

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

WorkerObject

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

Payroll_Reference_NumberObject

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

Payroll_Reference_NumberObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Payroll_Reference_NumberReferenceEnumeration

part of: Payroll_Reference_NumberObjectID
Base Type
string
top