ServiceRouterGetPayrollPolicies Method

Returns a GetPayrollPoliciesOut response with a result model List<GetPayrollPoliciesModel>

Namespace: AppOne.Services.V2
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141

Syntax

public GetPayrollPoliciesOut GetPayrollPolicies(
	GetPayrollPoliciesIn input
)

function GetPayrollPolicies(input);

Parameters

input GetPayrollPoliciesIn: A new GetPayrollPoliciesIn object

Return Value

GetPayrollPoliciesOut
A GetPayrollPoliciesOut object

Remarks

Use this method to get a results list of GetPayrollPoliciesModel. The GetPayrollPoliciesModel contains the meta data necessary to report on payroll policies.

DataAction Names

Name	Description	Values Example
SELECT-ALL	Returns all pay types in system regardless of any state.	[ignored]
SELECT-PAYID	Returns only the payroll pay types by the PayrollPolicyID input values.	["-1", "-4", "1", "8"]

Example

JSON Request

Copy

{
    "AuthToken":${#Project#Project_Token},
    "DataAction":{
        "Name":"SELECT-PAYID",
        "Values":["19","11","7"]
    }
}

JSON Response

Copy

{
   "Report":    {
      "APIVersion": "2.0",
      "ProcessTime": "0.0247143",
      "RequestTime": "/Date(1478114893456-0700)/",
      "ResponseTime": "/Date(1478114893481-0700)/",
      "Results": 3
   },
   "Results":    [
      {"General":       {
         "EffectiveDate": "/Date(1293865200000-0700)/",
         "EndDate": "/Date(4102556399000-0700)/",
         "ID": 33,
         "Members": 1,
         "Name": "Daily",
         "PayPeriodDays": 29,
         "PayPeriodEndDate": "/Date(1480489200000-0700)/",
         "PayPeriodStartDate": "/Date(1477983600000-0700)/",
         "PayrollPolicyID": 7
      }},
      {"General":       {
         "EffectiveDate": "/Date(1293865200000-0700)/",
         "EndDate": "/Date(4102556399000-0700)/",
         "ID": 62,
         "Members": 5,
         "Name": "BiWeekly",
         "PayPeriodDays": 13,
         "PayPeriodEndDate": "/Date(1479193200000-0700)/",
         "PayPeriodStartDate": "/Date(1478070000000-0700)/",
         "PayrollPolicyID": 11
      }},
      {"General":       {
         "EffectiveDate": "/Date(1325401200000-0700)/",
         "EndDate": "/Date(4102556399000-0700)/",
         "ID": 72,
         "Members": 1,
         "Name": "980",
         "PayPeriodDays": 13,
         "PayPeriodEndDate": "/Date(1478761200000-0700)/",
         "PayPeriodStartDate": "/Date(1477638000000-0700)/",
         "PayrollPolicyID": 19
      }}
   ]
}

SOAP: C# WCF Sample

Copy

public class PayrollPoliciesTest : BaseServiceTest
{
    #region SOAP: PayrollPolicies Details
    [TestMethod]
    [TestCategory("SOAP_V2")]
    public void V2_GetPayrollPolicies_SOAP_Test()
    {
        try
        {
            var actionTestLogic = new Action<SoapServiceV2.ServiceRouterClient>((client) =>
            {

                // ==================================
                //TEST 1: SELECT-EMPID 
                int countTest_1 = 0;
                SoapServiceV2.GetPayrollPoliciesRequest request1 = new SoapServiceV2.GetPayrollPoliciesRequest();
                request1.input = new SoapServiceV2.GetPayrollPoliciesIn
                {
                    AuthToken = AuthToken,
                    DataAction = new DataAction
                    {
                        Name = "SELECT-PAYID",
                        Values = new List<string>() { "1" }
                    },

                };
                SoapServiceV2.GetPayrollPoliciesResponse response1 = client.GetPayrollPolicies(request1);
                countTest_1 = (response1.GetPayrollPoliciesResult.Results != null) ? response1.GetPayrollPoliciesResult.Results.Count : 0;
                Assert.IsTrue(countTest_1 > 0);
            });

            RunServiceClient(actionTestLogic);
        }
        catch (FaultException<SoapServiceV2.ServiceException> fe)
        {
            Assert.Fail(fe.Detail.Message);
        }
    }
}

Reference

ServiceRouter Class

AppOne.Services.V2 Namespace

GetPayrollPoliciesModel