Service Directory > v31.2 > Payroll_GBR > Get_Payroll_SSP_History
 

Operation: Get_Payroll_SSP_History

Provides the ability to retrieve Payroll SSP History for a ~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: Get_Payroll_SSP_History_Request

Get Payroll SSP History Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_SSP_History_Request_References  [0..1]  Payroll SSP History References   
Request_Criteria [Choice]   Payroll_SSP_History_Request_Criteria  [0..1]  Payroll SSP History Request Criteria   
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  Payroll_SSP_History_Response_Group  [0..1]  Payroll SSP History Response Group   
top
 

Response Element: Get_Payroll_SSP_History_Response

Get Payroll SSP History Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_SSP_History_Request_References  [0..1]  Payroll SSP History References   
Request_Criteria  Payroll_SSP_History_Request_Criteria  [0..1]  Payroll SSP History Request Criteria   
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  Payroll_SSP_History_Response_Group  [0..1]  Payroll SSP History Response Group   
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  Payroll_SSP_History_Response_Data  [0..1]  Payroll SSP History Response Data   
top
 

Payroll_SSP_History_Request_References

part of: Get_Payroll_SSP_History_Request, Get_Payroll_SSP_History_Response
Payroll SSP History References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_SSP_History_Request_Reference  Unique_IdentifierObject  [1..*]  Payroll SSP History References   
top
 

Unique_IdentifierObject

part of: Payroll_SSP_History_Request_References, Payroll_SSP_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
 

Payroll_SSP_History_Request_Criteria

part of: Get_Payroll_SSP_History_Request, Get_Payroll_SSP_History_Response
Payroll SSP History Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..*]  Payroll SSP History Worker Reference   
top
 

WorkerObject

part of: Payroll_SSP_History_Data, Payroll_SSP_History_Request_Criteria
 
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_Payroll_SSP_History_Request, Get_Payroll_SSP_History_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
 

Payroll_SSP_History_Response_Group

part of: Get_Payroll_SSP_History_Request, Get_Payroll_SSP_History_Response
Payroll SSP History Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Payroll SSP History Reference in the Response   
top
 

Response_Results

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

Payroll_SSP_History_Response_Data

part of: Get_Payroll_SSP_History_Response
Payroll SSP History Response Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_SSP_History  Payroll_SSP_History  [0..*]  Payroll SSP History   
top
 

Payroll_SSP_History

part of: Payroll_SSP_History_Response_Data
Payroll SSP History
 
Parameter name Type/Value Cardinality Description Validations
Payroll_SSP_History_Reference  Unique_IdentifierObject  [0..1]  Payroll SSP History Reference   
Payroll_SSP_History_Data  Payroll_SSP_History_Data  [0..*]  Payroll SSP History Data 
Validation Description
First Day of SSP must be less than or equal to Last PIW Start Date.   
Total Number of Waiting Days must be less than or equal to 3.   
Last PIW End Date is required if SSP Absence History is selected.   
Last PIW Start Date is required if SSP Absence History is selected.   
Total Number of Payment Days for SSP must be zero, as First Day of SSP is more than 3 years ago.   
Total Number of Waiting Days must be zero, as First Day of SSP is more than 3 years ago.   
Total Number of Payment Days for SSP must be zero, as First Day of SSP is equal to Hire Date or Continuous Service Date.   
Total Number of Waiting Days must be zero, as First Day of SSP is equal to Hire Date or Continuous Service Date.   
Last PIW End Date must be at least 3 days later than Last PIW Start Date.   
Based on the number of qualifying days in the SSP History PIW entered ([qds]), Total Number of Waiting Days cannot be less than [num].   
Based on the number of qualifying days in the SSP History PIW entered ([qds]), Total Number of Payment Days for SSP should be greater than or equal to [num].   
Last PIW Start Date must be less than the Start Date of the Override First Processing Period.   
Last PIW End Date must be less than the Start Date of the Override First Processing Period.   
Total Number of Payment Days for SSP must be less than or equal to [num days].   
First Day of SSP cannot be earlier than Hire Date or Continuous Service Date.   
Last PIW Start Date cannot be less than First Day of SSP.   
Number cannot be zero since Number of SSP Weeks and Days Taken (Decimal Weeks) is present.   
Number must be less than or equal to 28.   
 
top
 

Payroll_SSP_History_Data

part of: Payroll_SSP_History
Payroll SSP History Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Average_Weekly_Earnings  decimal (14, 2) >0   [0..1]  Average Weekly Earnings   
SSP_Absence_History  boolean  [0..1]  SSP Absence History   
Last_PIW_Start_Date  date  [0..1]  Last PIW Start Date   
Last_PIW_End_Date  date  [0..1]  Last PIW End Date   
Total_Number_of_Waiting_Days  decimal (12, 0) >0   [0..1]  Total Number of Waiting Days   
Total_Number_of_Payment_Days_for_SSP  decimal (12, 0) >0   [0..1]  Total Number of Payment Days for SSP   
Number_of_SSP_Weeks_and_Days_Taken__Decimal_Weeks_  decimal (23, 3) >0   [0..1]  Number of SSP Weeks and Days Taken (Decimal Weeks)   
First_Day_of_SSP  date  [0..1]  First Day of SSP   
Validation Description
First Day of SSP must be less than or equal to Last PIW Start Date.   
Total Number of Waiting Days must be less than or equal to 3.   
Last PIW End Date is required if SSP Absence History is selected.   
Last PIW Start Date is required if SSP Absence History is selected.   
Total Number of Payment Days for SSP must be zero, as First Day of SSP is more than 3 years ago.   
Total Number of Waiting Days must be zero, as First Day of SSP is more than 3 years ago.   
Total Number of Payment Days for SSP must be zero, as First Day of SSP is equal to Hire Date or Continuous Service Date.   
Total Number of Waiting Days must be zero, as First Day of SSP is equal to Hire Date or Continuous Service Date.   
Last PIW End Date must be at least 3 days later than Last PIW Start Date.   
Based on the number of qualifying days in the SSP History PIW entered ([qds]), Total Number of Waiting Days cannot be less than [num].   
Based on the number of qualifying days in the SSP History PIW entered ([qds]), Total Number of Payment Days for SSP should be greater than or equal to [num].   
Last PIW Start Date must be less than the Start Date of the Override First Processing Period.   
Last PIW End Date must be less than the Start Date of the Override First Processing Period.   
Total Number of Payment Days for SSP must be less than or equal to [num days].   
First Day of SSP cannot be earlier than Hire Date or Continuous Service Date.   
Last PIW Start Date cannot be less than First Day of SSP.   
Number cannot be zero since Number of SSP Weeks and Days Taken (Decimal Weeks) is present.   
Number must be less than or equal to 28.   
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top