Service Directory > v32.1 > Payroll_Interface > Put_Integration_Event_Error_Message_Set
 

Operation: Put_Integration_Event_Error_Message_Set

This Put web service operation will allow importing the batch errors related to global payroll integration event(s) into 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: Put_Integration_Event_Error_Message_Set_Request

Wrapper Element for the Integration Event Error Message Set Request web service operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Integration_Event_Error_Message_Set_Data  Integration_Event_Error_Message_Set_Data  [0..*]  A container holding all the data to be reported to Workday that share the same integration event and pay group   
top
 

Response Element: Put_Integration_Event_Error_Message_Set_Response

Import error messages response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Status  string  [0..1]  Status   
top
 

Integration_Event_Error_Message_Set_Data

part of: Put_Integration_Event_Error_Message_Set_Request
A container holding all the data to be reported to Workday that share the same integration event and the same pay group
 
Parameter name Type/Value Cardinality Description Validations
Integration_Event_Reference  Global_Payroll_Integration_EventObject  [1..1]  Integration Event Reference   
Pay_Group_Reference  Pay_GroupObject  [0..1]  Pay Group Reference 
Validation Description
Pay Group is required when integration system template is of type Payroll Effective Change Interface.   
 
Integration_Event_Error_Message_Worker_Data  Integration_Event_Error_Message_Worker_Data  [0..*]  A section where all the worker related errors to be reported for a certain Integration Event and Pay Group can be grouped together 
Validation Description
Unable to save the data provided, the dependent fields "Is_Worker_Data" and "Worker_Reference" are not set properly, please provide values for both fields.   
 
top
 

Global_Payroll_Integration_EventObject

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

Global_Payroll_Integration_EventObjectID

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

Pay_GroupObject

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

Pay_GroupObjectID

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

Integration_Event_Error_Message_Worker_Data

part of: Integration_Event_Error_Message_Set_Data
A section where all the worker related errors to be reported for a certain Integration Event and Pay Group can be grouped together
 
Parameter name Type/Value Cardinality Description Validations
Is_Worker_Data  boolean  [0..1]  A boolean to specify whether the error data provided is related to a person or a foundational object. Setting the boolean to true enforces the field Worker_Reference to be required.   
Worker_Reference  WorkerObject  [0..1]  Worker Reference   
Foundational_Object_Type  string  [0..1]  An optional description of the foundational object type in which the error is tied to (Organization, Compensation Plan, ...)   
Integration_Event_Error_Message_Data  Payroll_Integration_Event_Error_Message_Data  [1..*]  A data set containing a group of errors and exceptions concerning an individual worker for a specific integration run and pay group   
top
 

WorkerObject

part of: Integration_Event_Error_Message_Worker_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_Integration_Event_Error_Message_Data

part of: Integration_Event_Error_Message_Worker_Data
The data set containing a group of errors concerning an individual worker for a specific integration run and pay group
 
Parameter name Type/Value Cardinality Description Validations
Record_Type  string  [0..1]  The type of the error being recorded.   
Message_Category  string  [0..1]  A text representation of the message category where the error occurred, example: Worker Data, Organization, Supervisory, Staffing...   
Functional_Area  string  [0..1]  The functional area that was impacted by this error reported, example: Position, Compensation, Personal data...   
Severity_Reference  Background_Process_Message_Severity_LevelObject  [0..1]  A reference to a severity level type, example: Critical, Error, Warning...   
Message_Number  string  [0..1]  An integer number identifying the error reported.   
Vendor_Error_Message  string  [1..1]  A required detailed error message, explaining what problems occurred for that worker while processing that record.   
Diagnosis  string  [0..1]  An explanation of why the error occurred.   
Procedure  string  [0..1]  A procedure is the required steps needed to be taken in order to overcome that error raised.   
Who  string  [0..1]  List the names, positions, or roles of the concerned audience for handling the error resolution.   
Integration_Event_Error_Message_Data_Group  Payroll_Integration_Event_Message_Data_Group  [0..*]  A group of optional data supplementing the main error being reported (Additional information)   
top
 

Background_Process_Message_Severity_LevelObject

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

Background_Process_Message_Severity_LevelObjectID

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

part of: Payroll_Integration_Event_Error_Message_Data
A group of optional data supplementing the main error being reported (Additional information)
 
Parameter name Type/Value Cardinality Description Validations
Group_Name  string  [1..1]  The category of the group holding the data to be provided, example: Allowance, Address...   
Group_Value  string  [1..1]  A more specific name of the type of data being provided, example: Car Allowance, Home Address...   
Integration_Event_Error_Message_Data_Group_Data  Payroll_Integration_Event_Message_Data_Group_Data  [0..*]  A group of attribute data supplementing the group data   
top
 

Payroll_Integration_Event_Message_Data_Group_Data

part of: Payroll_Integration_Event_Message_Data_Group
A group of attribute data supplementing the group data
 
Parameter name Type/Value Cardinality Description Validations
Field_Name  string  [1..1]  The name of the field attribute being reported, example: Amount, Currency, Status...   
Field_Value  string  [1..1]  The value of the field attribute being reported, example: 2000, USD, Active   
top
 

Global_Payroll_Integration_EventReferenceEnumeration

part of: Global_Payroll_Integration_EventObjectID
Base Type
string
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Background_Process_Message_Severity_LevelReferenceEnumeration

part of: Background_Process_Message_Severity_LevelObjectID
Base Type
string
top