Service Directory > v31.2 > Payroll > Get_W-2_W-2C_Printing_Election
 

Operation: Get_W-2_W-2C_Printing_Election

This web service operation is designed to get worker W-2/W-2C printing elections from either the Reference ID or the Worker Reference/Company Reference. If the domain for this task changes, also change the domain of Secure Method Definition, Worker@get Worker if in Request Otherwise Get all Workers for Company parm(SSC)*P*S[rsmb]+PA / Worker Data: Payroll (Company Specific) - USA (Secure Results by Domain), 5236$3342.


@ - 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_W-2_W-2C_Printing_Election_Request

Element to hold all W-2/W-2C Printing Election Request Information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  W-2_W-2C_Printing_Election_Request_References  [0..1]  Element to hold Request References   
Request_Criteria  W-2_W-2C_Printing_Election_Request_Criteria  [0..1]  Element to hold all criteria used to select which W-2/W-2C Printing Elections to return 
Validation Description
The Company specified is not valid for the Worker.   
 
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  W-2_W-2C_Printing_Election_Response_Group  [0..1]  Element to hold all information about the W-2/W-2C Printing Election Response Group   
top
 

Response Element: Get_W-2_W-2C_Printing_Election_Response

Get W-2/W-2C Printing Election Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  W-2_W-2C_Printing_Election_Request_References  [0..1]  All request references used to specify which W-2/W-2C Print Election to get   
Request_Criteria  W-2_W-2C_Printing_Election_Request_Criteria  [0..1]  All criteria used to specify which W-2/W-2C Print Election to get 
Validation Description
The Company specified is not valid for the Worker.   
 
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  W-2_W-2C_Printing_Election_Response_Group  [0..1]  Specifies how to group the W-2/W-2C Print Election that are returned   
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  W-2_W-2C_Printing_Election_Response_Data  [0..1]  Information to show for each W-2/W-2C Print Election returned   
top
 

W-2_W-2C_Printing_Election_Request_References

part of: Get_W-2_W-2C_Printing_Election_Request, Get_W-2_W-2C_Printing_Election_Response
Element to hold Request References
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company must be specified to obtain W-2/W-2C Printing Election   
top
 

CompanyObject

part of: W-2_W-2C_Printing_Election_Data, W-2_W-2C_Printing_Election_Request_References
 
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
 

W-2_W-2C_Printing_Election_Request_Criteria

part of: Get_W-2_W-2C_Printing_Election_Request, Get_W-2_W-2C_Printing_Election_Response
Element to hold all criteria used to select which W-2/W-2C Printing Elections to return
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker must be specified to obtain W-2/W-2C Printing Election   
Validation Description
The Company specified is not valid for the Worker.   
top
 

WorkerObject

part of: W-2_W-2C_Printing_Election_Request_Criteria, W-2_W-2C_Printing_Election
 
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_W-2_W-2C_Printing_Election_Request, Get_W-2_W-2C_Printing_Election_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
 

W-2_W-2C_Printing_Election_Response_Group

part of: Get_W-2_W-2C_Printing_Election_Request, Get_W-2_W-2C_Printing_Election_Response
Element to hold all information about the W-2/W-2C Printing Election Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference Boolean   
top
 

Response_Results

part of: Get_W-2_W-2C_Printing_Election_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
 

W-2_W-2C_Printing_Election_Response_Data

part of: Get_W-2_W-2C_Printing_Election_Response
Element to hold all data to Respond with about the W-2/W-2C Elections
 
Parameter name Type/Value Cardinality Description Validations
W-2_W-2C_Printing_Election  W-2_W-2C_Printing_Election  [0..*]  Element to hold all information about a W-2/W-2C Print Election   
top
 

W-2_W-2C_Printing_Election

part of: W-2_W-2C_Printing_Election_Response_Data
Element to hold all information about a W-2/W-2C Print Election
 
Parameter name Type/Value Cardinality Description Validations
XMLNAME__Worker__Reference  WorkerObject  [0..1]  This instance of Worker returned   
W-2_W-2C_Printing_Election_Data  W-2_W-2C_Printing_Election_Data  [0..1]  Element to hold all of the Data to Get the W-2/W-2C Print Election info.   
top
 

W-2_W-2C_Printing_Election_Data

part of: W-2_W-2C_Printing_Election
Element to hold all of the Data to Get the W-2/W-2C Print Election info.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  The Company of the Worker for which the W-2/W-2C Print Election is for   
Tax_Document_Delivery_Reference  Unique_IdentifierObject  [0..1]  The Tax Delivery Document on the W-2/W-2C Print Election   
Last_Updated  date  [0..1]  The Last Date the W-2/W-2C Print Election was changed   
Current_W-2_W-2C_Printing_Election  string  [0..1]  The Current Tax Document Election Print Status Statement of the W-2/W-2C Print Election   
top
 

Unique_IdentifierObject

part of: W-2_W-2C_Printing_Election_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  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
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top