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
Get Labor

Get Labor list.

URL

estate/sync/labors

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 2vY0zx1hQMqpmnoj1eTSGhuWzRhi64Xt Key obtained from authentiaction.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
Labor Array 1 25000 M 25000
lcode String 2 15 M R399 Labor Code received from estate/labor/details
name String 1 55 M CHANDRAKUMAR Labor name.
desigid Integer 1 25000 M 1 Designation ID
designame String 1 55 M LABOUR Designation Name
displaycode String 3 55 M MNJ-R1045 Labor code to display
musterfirmid Integer 1 500 M 3 Current firm ID of the worker. Should validate with firmid in Task
isHelper Character M F This labor is assigned helper task. Calculation on net weight changes according to this field.
T = Is Helper
F = Not Helper
laborFirmID Integer 1 500 M 3 Actual firm ID of the worker. This firm should be used to search the labor
isSupervisor Character M F This labor is assigned as supervisor. Supervisors don't have weighment in harvesting jobs.
T = Is Supervisor
F = Not Supervisor

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "Labor": [
        {
            "lcode": "R399",
            "name": "CHANDRAKUMAR",
            "desigid": "1",
            "designame": "LABOUR",
            "displaycode": "MNJ-R1045",
            "musterfirmid": "3",
            "isHelper": "F",
            "laborFirmID": "3",
            "isSupervisor": "F"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}