Click or drag to resize

GetTimePunchStateInDataAction Property

A simple query abstraction layer used to provide a mechanism by which methods can make simple query calls to various models.
* Required Property

Namespace: AppOne.Services.V2.Contracts
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141
Syntax
Copy
public DataAction DataAction { get; set; }

Property Value

DataAction
Remarks
The DataAction property is required to get results from GetTimePunchState(GetTimePunchStateIn) method. Below is a list of the available DataAction name values that can used to return a dynamic results set

DataAction Names

NameDescriptionValues Example
SELECT-EMPIDReturns only the users with the specified employee ID passed in the values property."abc-123","123","efg"...
Note  Note
If an invalid value is passed into the values parameter then it will be ignored at lookup time. For example if an EmpIdentifer of "777" is passed in and the value does not exist in the system then it will just be skipped.
Example
JSON Request
Copy
//EXAMPLE: Get the selected users punch state
{
    "AuthToken":"...",
    "DataAction":{
        "Name":"SELECT-EMPID",   
        "Values":["1234", "1337"]
    }
}
JSON Response
Copy
//EXAMPLE: Response for two requested users
{
    "Report": {
        "ProcessTime": "0.2025195",
        "RequestTime": "/Date(1430773866067-0700)/",
        "ResponseTime": "/Date(1430773866269-0700)/",
        "Results": 2
    },
    "Results": [
        {
            "EmpIdentifier": "1234",
            "PunchTypeId": "6,7,4,5,8,3,2",
            "PunchTypeName": "StartBreak,EndBreak,StartLunch,EndLunch,Transfer,ClockOut,ClockIn",
            "PunchStatus": "Blocked",
            "PunchMessage": "User is not eligible for a Begin Meal until 5/4/2015 3:42:00 PM"
        },
        {
            "EmpIdentifier": "1337",
            "PunchTypeId": "2,8,3",
            "PunchTypeName": "ClockIn,Transfer,ClockOut",
            "PunchStatus": "Valid",
            "PunchMessage": ""
        }
    ]
}
SOAP: C# WCF Sample
Copy
SoapServiceV2.GetTimePunchStateRequest request = new SoapServiceV2.GetTimePunchStateRequest();
request.input = new SoapServiceV2.GetTimePunchStateIn()
{
    AuthToken = AuthToken,
    DataAction = new DataAction()
    {
        Name = "SELECT-EMPID",
        Values = new List<string>() { "1234", "5555"}
    }
};
SoapServiceV2.GetTimePunchStateResponse response = client.GetTimePunchState(request);
Assert.IsTrue((response.GetTimePunchStateResult.Results != null ? response.GetTimePunchStateResult.Results.Count : 0) > 0);
See Also