Skip to main content

Employee Punch Details API

Note : You must configure the API permission constant (API-wise) in the tbl_systemworkflow table.

Only after setting this permission will the API be accessible.

UPDATE tbl_systemworkflow 
SET api_permissions = 'BIO_METRIC_PUNCH';

API Details

Endpoint

POST https://ess.emgage.work/api/daily-attendance-v1/employee-punch-data

API Permission

api_permissions = ['BIO_METRIC_PUNCH']

Headers

HeaderValue
APP-VERSION2
DEVICEBIO-METRIC
Content-Typeapplication/json
isSecurefalse
AuthorizationBearer {Provided Authenticate token}

Request Payload

Pass a list of objects in JSON format.

Request Fields

FieldTypeDescription
rfIdStringRF ID of the employee whose punch you want to record
punchDateStringPunch date and time in YYYY-MM-DD hh:mm:ss.SSS format
punchInOrOutString (Optional)Punch type (PUNCH IN or PUNCH OUT)

Sample Request

[
{
"rfId": "40066",
"punchDate": "2024-03-05 00:10:00.250"
},
{
"rfId": "40066",
"punchDate": "2024-03-05 08:30:00.250",
"punchInOrOut": "PUNCH OUT"
},
{
"rfId": "40066",
"punchDate": "2024-03-06 23:53:00.300",
"punchInOrOut": "PUNCH IN"
}
]

Response

Once the product processes all received data successfully, it returns:

  • code = 200
  • message = Success

If anything goes wrong, a different code or message is returned.
In such cases, retry the same punch data after some time.


Response Fields

FieldDescription
codeAPI response code
successStatus of request
messageAPI response message
responseObjIndividual punch processing result
countReserved field

Sample Success Response

{
"code": 200,
"success": true,
"message": "Success",
"responseObj": [
"40066>>>2024-03-05 00:10:00>>>->>>SUCCESS",
"40066>>>2024-03-05 08:30:00>>>->>>SUCCESS",
"40066>>>2024-03-06 23:53:00>>>->>>SUCCESS"
],
"count": null
}

Important Note

The responseObj field contains the processing result for each individual punch sent in the request.

Example:

40066>>>2024-03-05 08:30:00>>>->>>SUCCESS

This indicates:

  • RF ID: 40066
  • Punch Date: 2024-03-05 08:30:00
  • Status: SUCCESS

Was this page helpful?