ServiceRouterGetUserPayAdjust Method

Returns a GetUserPayAdjustOut response with a result model List<GetUserPayAdjustModel>

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

Syntax

public GetUserPayAdjustOut GetUserPayAdjust(
	GetUserPayAdjustIn input
)

function GetUserPayAdjust(input);

Parameters

input GetUserPayAdjustIn: A new GetUserPayAdjustIn object

Return Value

GetUserPayAdjustOut
A GetUserPayAdjustOut object

Exceptions

Exception	Condition
ServiceException	Start Date and End Date range should be with in 45 days

Remarks

Use this method to get a results list of GetUserPayAdjustModel. The GetUserPayAdjustModel contains the meta data necessary to report on a a users pay adjustments.

DataAction Names

Name	Description	Values Example
SELECT-EMPID	Returns only the users with the specified employee ID passed in the values property.	"abc-123","123","efg"...
SELECT-ALL	Returns All Pay Adjustments belonging to Active Users in the Selected Date Range

Note
The StartDate and EndDate both should be withing 180 days of each other or an exception will be returned. To increase the responsiveness of this service call use a short time span between the StartDate and EndDate.

Example

JSON Request

Copy

{
    "AuthToken":"...",
    "StartDate":"\/Date(1467356400000-0700)\/",
    "EndDate":"\/Date(1472713200000-0700)\/",
    "DateTimeSchema":0,
    "DataAction":{
        "Name":"SELECT-EMPID",
        "Values":["1234"]
    }
}

JSON Response

Copy

{
    "Report": {
        "APIVersion": "2.0",
        "ProcessTime": "0.0116505",
        "RequestTime": "/Date(1472765055231-0700)/",
        "ResponseTime": "/Date(1472765055242-0700)/",
        "Results": 1
    },
    "Results": [
        {
            "Amount": 77.77,
            "ClosedType": 0,
            "EmpApproved": false,
            "IsModified": false,
            "MgrApproved": false,
            "Notes": "String_Content",
            "PayAdjustmentDataSource": 0,
            "PayAdjustmentDataType": 0,
            "PayAdjustmentDate": "/Date(1470060000000-0700)/",
            "PayAdjustmentDateSchema": "2016-08-01T07:00:00",
            "PayPerUnit": 0,
            "TimeSlicePreID": 0,
            "Unit": 77.77,
            "ID": 96,
            "PayAdjustmentID": 1,
            "EmpIdentifier": "1234",
            "LL01ID": 35,
            "LL02ID": 2,
            "LL03ID": 0,
            "LL04ID": 0,
            "LL05ID": 0,
            "LL06ID": 0,
            "LL07ID": 0,
            "LL08ID": 0,
            "LL09ID": 0,
            "LL10ID": 0,
            "LL11ID": 0,
            "LL12ID": 0,
            "LL13ID": 0,
            "LL14ID": 0,
            "LL15ID": 0
        }
    ]
}

SOAP: C# WCF Sample

Copy

public void V2_GetUserPayAdjust_SOAP_Test()
{
    try
    {
        var actionTestLogic = new Action<SoapServiceV2.ServiceRouterClient>((client) =>
        {
            // ==================================
            //TEST 1: SELECT-ID
            int countTest_1 = 0;
            SoapServiceV2.GetUserPayAdjustRequest request2 = new SoapServiceV2.GetUserPayAdjustRequest();
            request2.input = new SoapServiceV2.GetUserPayAdjustIn
            {
                AuthToken = AuthToken,
                //Must be 180 day window
                StartDate = new DateTime(2016, 08, 01),
                EndDate = new DateTime(2016, 09, 30),
                DataAction = new DataAction
                {
                    Name = "SELECT-EMPID",
                    Values = new List<string> { "1234" }
                }
            };
            SoapServiceV2.GetUserPayAdjustResponse response1 = client.GetUserPayAdjust(request2);
            countTest_1 = response1.GetUserPayAdjustResult.Results.Count;
            Assert.IsTrue(countTest_1 > 0);
        });

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

Reference

ServiceRouter Class

AppOne.Services.V2 Namespace

GetUserPayAdjustModel