Service Directory > v31.2 > Payroll > Put_ROE_History_Data
 

Operation: Put_ROE_History_Data

This Web service is used to update the ROE History instances statuses, issued date, and issued number when the file is imported from Service Canada into Workday System.


@ - 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: Put_ROE_History_Data_Request

Canadian Record of Employment History data request element that contains Record of Employment History data to be updated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ROE_History_Data  ROE_History_Data  [1..1]  ROE History Data element containing attributes needed 
Validation Description
Payroll Reference Number is not valid for the specified company and issue date.   
 
top
 

Response Element: Put_ROE_History_Data_Response

This is the Canadian Record of Employment History Data Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ROE_Data_Reference  Unique_IdentifierObject  [0..1]  The ROE History Data Reference   
top
 

ROE_History_Data

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

Unique_IdentifierObject

part of: ROE_History_Data, Put_ROE_History_Data_Response
 
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
 

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