Touch services for smartphones are used to check in and out,

 

a)TouchCheckIn

The TouchCheckIn method allows the user to check in from a smartphone.

 

Request (JSON)

POST/Attendance/TouchCheckIn/?securityToken={tokenId}

 

Body:

Null

 

Response (JSON)

{
"CheckInTime": "12:37",
"CheckOutTime": "null",
"CurrentTime": "12:48:32",
"CurrentStatus": "AllowCheckOut",
"EnableShiftBreakCodePanel": "true",
"IsCheckedInElsewhere": "false",
}

 

b) TouchCheckOut

Similar to the TouchCheckIn method, the TouchCheckOut method calls the CheckOut service and returns an AttendanceInformation object, updated with the CheckOutTime. If the break time is empty, insert null.

 

Request (JSON)

POST /Attendance/TouchCheckOut/{breakcodeid}/?securityToken={tokenId}

 

Body:

Null

 

Response (JSON)

{
"CheckInTime": "12:37",
"CheckOutTime": "15:45",
"CurrentTime": "15:45:00",
"CurrentStatus": "AllowCheckIn",
"EnableShiftBreakCodePanel": "false",
"IsCheckedInElsewhere": "false",
}

c) GetTouchStatus

This method returns an AttendanceInformation type of object, updated with the latest information.

 

Request (JSON)

GET /Attendance/GetTouchStatus/?securityToken={tokenId}

 

Body:

Null

 

Response (JSON)

{
"CheckInTime": "12:37",
"CheckOutTime": "null",
"CurrentTime": "12:48:32",
"CurrentStatus": "AllowCheckOut",
"EnableShiftBreakCodePanel": "true",
"IsCheckedInElsewhere": "false",
}

 

d) GetBreakCodes

This method returns a list of AttendanceBreakCode types of objects, with the break codes corresponding to a certain employee. Breakcodeid is optional. However, if sent, the service will return a list with the breakcodeid’s.

 

Request (JSON)

GET /Attendance/GetBreakCodes/?securityToken={tokenId}&breakcodeid={breakcodeid}

 

Body:

Null

 

Response (JSON)

[{"BreakCodeID":"1",
"Code":"12",
"Enabled":"false",
"Hours":"0.12",
"Name":"Q",
"Selected":"true"},
...
[{"BreakCodeID":"4",
"Code":"30",
"Enabled":"false",
"Hours":"1.5",
"Name":"R",
"Selected":"true"}]

 

e) UpdateBreakCode

This method is used in the application when a user is selecting a certain break code. The purpose is to update the property of the selected break code. The method returns a ResponseMessage, which has the Success = true in the case that the break code was successfully updated, and Success = false otherwise.

 

Request (JSON)

POST /AttendanceService/UpdateBreakCode/{breakcodeid}/?securityToken={tokenId}

 

Body:

Null

 

Response (JSON)

{Message:””,  Success:”true”}

f) GetTouchAccess

The GetTouchAccess method is used to decide whether a device has access to Touch or not.

In the case that the company does not have the option AlwaysCheckIPOnTouchLogin enabled, the device using Touch will always be able to use it. Otherwise, a set of checks on the IP address is made – this is used when components are first initialised in the smartphone versions.

 

Request (JSON)

GET/AttendanceService/GetTouchAccess/ securityToken={tokenId}

 

Body:

Null

 

Response (JSON)

{Message:””  Success:”false”}