Service Directory > v32.1 > Benefits_Administration > Put_Worker_Wellness_Data
 

Operation: Put_Worker_Wellness_Data

This service operation creates/updates Wellness Data for a given worker.


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

Wrapper element for the Put Worker Wellness Data Request information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Wellness_Data_Data  Worker_Wellness_Data_Data  [1..1]  Contains the Worker Wellness Data data. 
Validation Description
Effective date must be empty when Wellness Score Date or Participates in Wellness Date or Uses Tobacco Date are not. Conversely when Effective date is not empty, Wellness Score Date, Participates in Wellness Date and Uses Tobacco Date must be empty.   
Dependent is not eligible for Wellness.   
 
top
 

Response Element: Put_Worker_Wellness_Data_Response

Wrapper element for the Put Worker Wellness Data Response information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Wellness_Data_Reference  Unique_IdentifierObject  [0..1]  A unique identifier for an Worker Wellness Data.   
top
 

Worker_Wellness_Data_Data

part of: Put_Worker_Wellness_Data_Request
Contains the Worker Wellness Data data.
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The effective date for the Worker Wellness Data. When present this date applies to all the Wellness fields.   
Worker_Reference [Choice]   WorkerObject  [1..1]  The worker for the Wellness Data.   
Dependent_Reference [Choice]   DependentObject  [1..1]  The dependent for the Wellness Data.   
Participates_in_Wellness_Date  date  [0..1]  Date when worker or dependent participated in a Wellness Program.   
Participates_in_Wellness_Program  boolean  [0..1]  Whether worker participates in a Wellness Program for the Worker Wellness Data.   
Wellness_Score_Date  date  [0..1]  Date for Wellness Score   
Wellness_Score  decimal (14, 2) >0   [0..1]  The score for the Worker Wellness Data.   
Uses_Tobacco_Date  date  [0..1]  Date of Tobacco Use.   
Uses_Tobacco  boolean  [0..1]  Whether worker uses tobacco.   
Validation Description
Effective date must be empty when Wellness Score Date or Participates in Wellness Date or Uses Tobacco Date are not. Conversely when Effective date is not empty, Wellness Score Date, Participates in Wellness Date and Uses Tobacco Date must be empty.   
Dependent is not eligible for Wellness.   
top
 

WorkerObject

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

DependentObject

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

DependentObjectID

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

Unique_IdentifierObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

DependentReferenceEnumeration

part of: DependentObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top