Employee Clock In and Out

Introduction

The Clock In and Out endpoint provides a streamlined and efficient method for recording employee/worker time on-site. Offering focused functionality and ease of use. Users can easily integrate this endpoint into their applications and accurately record time events for their workforce.

This documentation aims to guide users on how to utilize this endpoint effectively to record time points accurately.

The Pyempclockinout endpoint allows the recording of time points for employees/workers. Each time point represents a specific event, such as clocking in, clocking out, or taking a break.

Create a Employee Clock In and Out Record

The payload for creating a record should contain the following attributes:

1. EcioVUuid: This attribute is system-generated and should be left empty. The system will generate a unique value for it automatically.

2. EcioEmpNo: Specify the employee/worker's unique identifier within the system. Ensure that the employee is already set up in the system before recording time.

3. EcioType: Choose from three available types: "IN" (clocking in), "OUT" (clocking out), or "BRKE" (break time).

4. EcioDatetime: Capture the date and time of the time point. The format should follow the ISO 8601 standard, including the time zone offset.

5. EcioGpsLatitude and EcioGpsLongitude: These attributes allow capturing GPS coordinates. If GPS data is not required, they can be left as null.

6. EcioAutoCreatedFlag: This attribute is optional and can be left as null. It indicates whether the time point was automatically created.

https://{add CMiC domain}/{add CMiC server}/hcm-rest-api/rest/1/pyempclockinout

Sample Payload

{
    "EcioVUuid": "", 
    "EcioEmpNo": "GERALD", 
    "EcioType": "OUT",  
    "EcioDatetime": "2023-08-01T09:18:58-06:00", 
    "EcioGpsLatitude": null, 
    "EcioGpsLongitude": null, 
    "EcioAutoCreatedFlag": null
}

Retrieve Employee Clock In and Out Record

https://{add CMiC domain}/{add CMiC server}/hcm-rest-api/rest/1/pyempclockinout?finder=selectByEmpNo;empNo=IA20029