Click or drag to resize

ServiceRouterUserInfoGetPolicyDuration Method

Returns a UserInfoGetPolicyDurationOut response with a result model List<UserInfoGetPolicyDurationModel>

Namespace: AppOne.Web.Service.Services.V1R0
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141
Syntax
Copy
public UserInfoGetPolicyDurationOut UserInfoGetPolicyDuration(
	UserInfoGetPolicyDurationIn param
)

Parameters

param  UserInfoGetPolicyDurationIn
A new UserInfoGetPolicyDurationIn object

Return Value

UserInfoGetPolicyDurationOut
A UserInfoGetPolicyDurationOut object
Remarks
Returns a UserInfoGetPolicyDurationOut response with a result model List<UserInfoGetPolicyDurationModel>. This method will get a list of employees meal/break duration's and return additional flags to indicate the status of a users shift cycle.

Note  Note
Break/Meal duration's can have multiple values for a given day, therefore a break may come back with three separate durations and a meal could come back with two or vice versa. There are also instances where no duration will come back. In short durations are dynamic and can have any number of different combinations that may be returned for either a meal or break. The amount of durations is based on the payroll policy's configuration.
Note  Note
Setup:
Manager > Employees > Policies > Payroll Policy
Configuration > Payroll Processing > Payroll Policies > Meals/Breaks

Business Rules:
The is a hierarchy level that comes into effect when working with break and meal durations.
  1. A payroll policy can have a 'Meal' and 'Break' rules assigned to it
  2. A 'Meal' and 'Break' can be of type 'Auto' or 'Manual'
  3. A 'Meal' can have multiple durations assigned to it
  4. A 'Break' can have multiple durations assigned to it
The RuleType will indicate if the break is either 'Auto' or 'Manual'.
Example
REST: JSON Request
Copy
{
    "AuthToken":"String_Content",
    "EmpIdentifiers":["String_Content"]
}
REST: JSON Response
Copy
{
    "Results": [
        {
            "EmpIdentifier": "1234",
            "PayrollPolicyID": 7,
            "Meals": {
                "AllowManOverride": false,
                "RuleType": 1,
                "Durations": [
                    {
                        "AllowSecs": 1200,
                        "AutoEndSecsAfterClockIn": 0,
                        "AutoExtraSecs": 0,
                        "AutoShiftType": 0,
                        "AutoStartSecsAfterClockIn": 0,
                        "AutoStartsAtTime": "/Date(-62135571600000-0700)/",
                        "DetailID": 14,
                        "IsActive": false,
                        "IsNext": true,
                        "IsPaid": false,
                        "ManualBreakAvailableAfterSecs": 3600
                    }
                ]
            },
            "Breaks": {
                "AllowManOverride": true,
                "RuleType": 2,
                "Durations": [
                    {
                        "AllowSecs": 7380,
                        "AutoEndSecsAfterClockIn": 0,
                        "AutoExtraSecs": 0,
                        "AutoShiftType": 1,
                        "AutoStartSecsAfterClockIn": 0,
                        "AutoStartsAtTime": "/Date(-2208891600000-0700)/",
                        "DetailID": 4,
                        "IsActive": false,
                        "IsNext": true,
                        "IsPaid": false,
                        "ManualBreakAvailableAfterSecs": 0
                    },
                    {
                        "AllowSecs": 1320,
                        "AutoEndSecsAfterClockIn": 0,
                        "AutoExtraSecs": 0,
                        "AutoShiftType": 2,
                        "AutoStartSecsAfterClockIn": 0,
                        "AutoStartsAtTime": "/Date(-2208920400000-0700)/",
                        "DetailID": 6,
                        "IsActive": false,
                        "IsNext": false,
                        "IsPaid": false,
                        "ManualBreakAvailableAfterSecs": 0
                    }
                ]
            }
        }
    ]
}
See Also