Time Web Services API
Namespaces
AppOne.Services.V2
ServiceRouter Class
ServiceRouter Methods
AddHolidayList Method
AddHolidayListDetail Method
AddLaborLevelDetail Method
AddPayrollPayType Method
AddUserLaborLevel Method
AddUserPayAdjust Method
AddUserSchedule Method
AddUserScheduleDetail Method
AddUserTimeNonWorkShift Method
AddUserTimeOffRequest Method
CreateToken Method
DeleteHolidayList Method
DeleteHolidayListDetail Method
DeleteLaborLevelDetail Method
DeletePayrollPayType Method
DeleteUser Method
DeleteUserLaborLevel Method
DeleteUserPayAdjust Method
DeleteUserSchedule Method
DeleteUserScheduleDetail Method
GetCustomerConfig Method
GetCustomField Method
GetHolidayList Method
GetHolidayListDetail Method
GetLaborLevel Method
GetLaborLevelDetail Method
GetPayrollPayAdjust Method
GetPayrollPayType Method
GetPayrollPolicies Method
GetPunchPrompts Method
GetSSOEnabled Method
GetSSOLink Method
GetTimeOffPolicy Method
GetTimeOffPolicyDetail Method
GetTimeOffPolicyDetailRule Method
GetTimePunchState Method
GetToken Method
GetUserBasic Method
GetUserDetail Method
GetUserGroups Method
GetUserIPAccess Method
GetUserLaborLevel Method
GetUserLogins Method
GetUserPayAdjust Method
GetUserSchedule Method
GetUserTimeOffBalance Method
GetUserTimeOffRequest Method
GetUserTimeOnStatusBoard Method
PingTest Method
UpdateHolidayList Method
UpdateLaborLevelDetail Method
UpdatePayrollPayType Method
UpdateUserLaborLevel Method
UpdateUserPayAdjust Method
UpdateUserSchedule Method
UpdateUserScheduleDetail Method
UpdateUserTimeApproval Method
UpdateUserTimePunch Method
Click or drag to resize

ServiceRouterGetPunchPrompts Method

Return a GetPunchPromptsOut response with a result model List<GetPunchPromptsModel>

Namespace: AppOne.Services.V2
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141
Syntax
Copy
public GetPunchPromptsOut GetPunchPrompts(
	GetPunchPromptsIn input
)

Parameters

input  GetPunchPromptsIn

Return Value

GetPunchPromptsOut
A GetPunchPromptsOut object
Remarks
Use this method to get a results list of GetPunchPromptsModel

Note  Note
For a higher level overview of the business rules for punch prompts see the class WSPunchPrompts of this web method.

DataAction Names

NameDescriptionValues Example
SELECT-EMPIDReturns only the users with the specified employee ID passed in the values property."abc-123","123","efg"...

Punch Transaction Type

NameDescription
PunchTypeThis is a nullable property, if it having a value, punch prompt will results only specific to those selected punch type else returns all punch type prompts details
Caution note  Caution
Please note the following

1. The preference policy of a user will control which punch prompts can be displayed.
Please validate the Preference policy of each employee if results are not coming back as expected
Example
JSON Request
Copy
//EXAMPLE: Get the selected users Punch Prompts
{
    "AuthToken":"...",
    "DataAction":{
        "Name":"SELECT-EMPID",   
        "Values":["EMP01"]
    }
    "PunchTypeID":2
}
JSON Response
Copy
//EXAMPLE: Response for two requested users
{
    "Report": {
        "ProcessTime": "0.2025195",
        "RequestTime": "/Date(1430773866067-0700)/",
        "ResponseTime": "/Date(1430773866269-0700)/",
        "Results": 2
    },
    "Results": [
       {
            "UserID": 22,
            "EmployeeIdentifier": "EMP 01",
            "PunchPrompts": [
                {
                    "PunchPromptQuestionID": 3,
                    "QuestionText": "TextBox",
                    "AnswerFieldType": 0,
                    "HasDefinedAnswers": true,
                    "DefinedAnswers": [
                        {
                            "AnswerData": "Bangalore",
                            "OrdinalPosition": 1,
                            "PunchPromptDefinedAnswerID": 1,
                        },
                        {
                            "AnswerData": "Mysore",
                            "OrdinalPosition": 2,
                            "PunchPromptDefinedAnswerID": 2,
                        }
                    ],
                    "OrdinalPosition": 1,
                    "IsRequired": true,
                    "PromptOnClockIn": false,
                    "PromptOnBeginBreak": true,
                    "PromptOnEndBreak": true,
                    "PromptOnTransfer": true,
                    "PromptOnBeginMeal": true,
                    "PromptOnEndMeal": true,
                    "PromptOnClockOut": true
                },
                {
                    "PunchPromptQuestionID": 4,
                    "QuestionText": "Number",
                    "AnswerFieldType": 2,
                    "HasDefinedAnswers": false,
                    "DefinedAnswers": [],
                    "OrdinalPosition": 2,
                    "IsRequired": true,
                    "PromptOnClockIn": true,
                    "PromptOnBeginBreak": true,
                    "PromptOnEndBreak": true,
                    "PromptOnTransfer": true,
                    "PromptOnBeginMeal": true,
                    "PromptOnEndMeal": true,
                    "PromptOnClockOut": true
                },
                {
                    "PunchPromptQuestionID": 2,
                    "QuestionText": "Date",
                    "AnswerFieldType": 1,
                    "HasDefinedAnswers": false,
                    "DefinedAnswers": [],
                    "OrdinalPosition": 3,
                    "IsRequired": true,
                    "PromptOnClockIn": true,
                    "PromptOnBeginBreak": true,
                    "PromptOnEndBreak": true,
                    "PromptOnTransfer": true,
                    "PromptOnBeginMeal": true,
                    "PromptOnEndMeal": true,
                    "PromptOnClockOut": true
                }
            ]
        }
    ]
}
See Also