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 Tasks

Get Task list

URL

estate/sync/taskdetails

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 5UWCx0Ps6itUKBevwUQxB4ZejTt3hDOS Key obtained from authentiaction.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
Task Array 1 50 M List of tasks
firmid Integer 1 500 M 1 Firm ID
TaskID Integer 1 2147483647 M 46 Task ID
Date String 10 10 M 2019-04-30 Task date.
Crop String 1 50 M TEA Crop Name
Field String 1 50 M TF18 Field Name
Job String 1 150 M SHEAR PLUCKING [SP] Job Name
laborCount Integer 1 1000 M 7 Maximum allowed labor
cropID Integer 1 5000 M 1 Crop ID
FieldCode Integer 1 25000 M 74 Field Code
JobCode Integer 1 25000 M 79 Job Code
HarvestJob Character M T T = Harvest job
F = Other jobs
Harvest jobs need weighment.
MaterialReqd Character M T T = Material required
F = No materials for job
CocktailReqd Character M T T = Cocktail required
F = No cocktail for job
firm String 1 50 M MUNJAMULLAY ESTATE Firm Name
MoisturePerc Decimal 1 25 M 2.25 Percentage of moisture
BagWeight Decimal 1 10 M 1.25 Weight of the bag.
firmCode String 2 10 M MNJ Firm short name. Display this instead of firmid where space is restricted.
sprayer String 50 M Power Sprayer Sprayer name. This field will be blank for non spraying jobs
DiarySlipNo Integer 1 2147483647 M 1 Diary Slip number
Materials Array 50 M List of required materials
This is available only when MaterialReqd = 'T'
MaterialCode Integer 1 2147483647 M 18877 Material code
MaterialName String 1 50 M PWT Material name
Qty Decimal 1 20000 M 4.95 Quantity of the material
Cocktails Array 50 M List of required cocktails
This is available only when CocktailReqd = 'T'
cocktailname String 1 50 M F1 Name of the cocktail
cocktailcode Integer 1 2000 M 3 ID of the cocktail
Materials Array 1 50 M List of materials in the cocktail
MaterialCode Integer 1 2147483647 M 18877 Material code
MaterialName String 1 50 M PWT Material name
Qty Decimal 1 20000 M 4.95 Quantity of the material
pests Array M Details of pests for the task. The pest details are available only for harvesting jobs. There must be for all the pests in the task when posting muster. If there is no value '0' should be entered.
pestID Integer 1 M 1 ID of the pest to be sent with muster.
Pest String 3 30 M BLISTER BLIGHT Name of the pest.
PestsReqd Character M T T = Pest analysis required
F = No pest analysis for job

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "Task": [
        {
            "firmid": "1",
            "TaskID": "46",
            "Date": "2019-04-30",
            "Crop": "TEA",
            "Field": "TF18",
            "Job": "SHEAR PLUCKING [SP]",
            "laborCount": "7",
            "cropID": "1",
            "FieldCode": "74",
            "JobCode": "79",
            "HarvestJob": "T",
            "MaterialReqd": "T",
            "CocktailReqd": "T",
            "firm": "MUNJAMULLAY ESTATE",
            "MoisturePerc": "2.25",
            "BagWeight": "1.25",
            "firmCode": "MNJ",
            "sprayer": "Power Sprayer",
            "DiarySlipNo": "1",
            "Materials": [
                {
                    "MaterialCode": "18877",
                    "MaterialName": "PWT",
                    "Qty": "4.95"
                }
            ],
            "Cocktails": [
                {
                    "cocktailname": "F1",
                    "cocktailcode": "3",
                    "Materials": [
                        {
                            "MaterialCode": "18877",
                            "MaterialName": "PWT",
                            "Qty": "4.95"
                        }
                    ]
                }
            ],
            "pests": [
                {
                    "pestID": "1",
                    "Pest": "BLISTER BLIGHT"
                }
            ],
            "PestsReqd": "T"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}