Codelayer API Documentation

  • Introduction

    • General
    • Version History
  • API Reference

    • System

      • License request
      • Register Device
      • Authentication
      • Settings
    • HR Details

      • Employee Attendance
      • Employee Leave Summary
      • Employee List
      • Employee Payrevision
      • Employee Payroll
      • Employee Relieving
      • Employee TDS Calculated
      • Employee TDS Deducted
      • Employee Transfer
      • Employees Edited
    • Estate

      • Labor

        • Details
        • Register Face
      • Sync

        • Download Face File
        • Get Labor
        • Get Tasks
        • Post Muster
      • Authentication
      • Firm List
    • FrontOffice Poabs

      • Gatepass Save
    • Response Codes
Codelayer API Documentation
Employee List

This API gives list of employees added in a unit after a given date.

URL

hrdetails/emp_newjoin

Method

POST

Request Media type

application/json

Response Media type

application/json

Request Parameters
Parameter Data Type Min Max M/O Sample Value Comments
key String 32 32 M 4bW97M7vVOAhqqFNl0ep71Rn7wusg51a Key obtained from authentiaction.
from String 10 10 M 2010-10-10 The from date in yyyy-MM-dd format
unitid Integer 1 M 45 Firm id from unit list

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
employee Array M Employee List Array
co_id String 1 10 M 009 Employe Central Code
name String 5 M SAMPLE NAME Name of Employee
sex Character M M Male = M/ Female = F / Transgender = T
dob String 10 10 M 1981-01-01 In YYYY-MM-DD format
pan String 10 10 M AAAPL1234C
doj String 10 10 M 2010-01-01 Date of Join in YYYY-MM-DD format
hname String 5 100 M Sample House Name House Name
place String 1 100 M Sample Place Place
district String 1 100 M Sample District District
post String 1 100 M Sample Post Post
cpf Decimal M 0 CPF for the Employee

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "from": "2010-10-10",
    "unitid": "45"
}
Sample Success Response
{
    "employee": [
        {
            "co_id": "009",
            "name": "SAMPLE NAME",
            "sex": "M",
            "dob": "1981-01-01",
            "pan": "AAAPL1234C",
            "doj": "2010-01-01",
            "hname": "Sample House Name",
            "place": "Sample Place",
            "district": "Sample District",
            "post": "Sample Post",
            "cpf": "0"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}