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
Details

Gets the details of labour.

URL

estate/labor/details

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 hGesWp2PNHi7RtgdUbmu3uDJh6OjAZLA Key obtained from authentiaction.
code String 1 10 M 558 Labor display Code (Code shown in PEMS front-end)
firmID Integer 1 3000 M 2 Firm ID (Operating Unit Id)
ltype Character M R Labor Type R=Regular, C=Casual

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
firmID Integer 1 500 M 1 Firm ID
firmName String 1 55 M MUNJAMULLAY ESTATE Firm Name
lcode String 2 15 M 29C399, R101 Labor unique Code to save the image and other details. Format: Regular=> R Casual=> C
name String 1 55 M CHANDRAKUMAR Labor name.
fatherName String 55 M A SANGILIRAJ Father's name.
gender String 1 1 M M M=Male, F=Female
address String 100 M EDAIKAL, TENKASI, THIRUNELVELI DISTRICT Address of labor

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "code": "558",
    "firmID": "2",
    "ltype": "R"
}
Sample Success Response
{
    "firmID": "1",
    "firmName": "MUNJAMULLAY ESTATE",
    "lcode": "29C399, R101",
    "name": "CHANDRAKUMAR",
    "fatherName": "A SANGILIRAJ",
    "gender": "M",
    "address": "EDAIKAL, TENKASI, THIRUNELVELI DISTRICT",
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 407,
    "msg": "Resource not found."
}