# Task 🎨

# Task Create 🎨

📌 POST:/task/taskcreate

# Request (Body)

  • taskno : String Alpha Numeric Max 10 Character
  • clientno : String Alpha Numeric Max 10 Character
  • taskname : String Alpha Space Max 50 and Min 2 Characters
  • taskstatus : Contains ['G', 'C', 'I', 'S']
  • taskpriority: Integer between 1 to 5
  • serviceno | complianceid : SmallInt
  • descp : String Alpha Space Max 300 Characters
  • compyear : Integer between 2000 to 2100
  • compperiodicity : Contains ['Y', 'H', 'Q', 'M']
  • compperiod : Alpha Numeric, based on compperiodicity.
    • "Y" : 1
    • "H" : "H1", "H2"
    • "Q" : "Q1", "Q2", "Q3", "Q4"
    • "M" : Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec
  • iscomp : Contains 0,1
  • dtcreate | dttarget | dtdue | dtcomplete : String Date
  • category | pcenter | ccenter : String Alpha Numeric Max 20 characters

For creating a task, the user needs to have taskcreate permission.
If taskno is not set, the respective task gets assigned the next taskno based on previous taskno, after the master is setup

# Response

// Success
{
  "data": [
    {...}
    {...}
  ],
  "success":true,
  "msg": "Task Created"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Search 🎨

📌 POST:/task/tasksearch

# Request (Body)

  • tasknos : Array of String : Array max 2000 Items, String Alpha Numeric Max 10 Digits
  • clientnos : Array of String : Array max 1000 Items, String Alpha Numeric Max 10 Digits
  • groupnos : Array of String : Array max 1000 Items, String Alpha Numeric Max 10 Digits
  • dtcreate | dttarget | dtdue | dtcomplete : An Array of 2 String Date, where the 1st element is the from date and 2nd element is the to date.

# Response

// Success
{
  "data": [
    {...},
    {...}
  ],
  "success":true,
  "msg":"Task Loaded"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task View 🎨

📌 POST:/task/taskview

# Request (Body)

  • taskno : String Alpha Numeric Max 10 Digits

For exploring a task, the user needs to have hasotherreport permission.

# Response

// Success
{
  "data": {
    "task": {..},
    "team": [{...}],
    "label": []
  },
  "success": true,
  "msg": "Task Loaded"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Delete 🎨

📌 POST:/task/taskdelete

# Request (Body)

  • taskno : String Alpha Numeric Max 10 Digits

For Deleting a task, the user needs to have hasdelete permission.

# Response

// Success
{
  "data": [
    {...}
    {...}
  ],
  "success":true,
  "msg": "Task Deleted"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Update 🎨

📌 POST:/task/taskupdate

# Request (Body)

  • taskno* : String Alpha Numeric Max 10 Character
  • taskname : String Alpha Space Max 50 and Min 3 Characters (Optional)
  • taskname2 : String Alpha Space Max 50 and Min 3 Characters (Optional)
  • descp : String Alpha Space Max 300 Characters (Optional)
  • compyear : Integer between 2000 to 2100
  • compperiod : Alpha Numeric, based on compperiodicity.
    • "Y" : 1
    • "H" : "H1", "H2"
    • "Q" : "Q1", "Q2", "Q3", "Q4"
    • "M" : Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec
  • category | pcenter | ccenter : String Alpha Numeric Max 20 characters

For Updating a task, the user needs to have hastask permission.

# Response

//sucess
{
  "success": true,
  "msg": "Task Updated",
  "params": {...},
  "no": ".."
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Verify

📌 POST:/task/taskverify

# Request (Body)

  • taskno* : String Max 10 Characters , Only Alpha Numeric .
  • verifynote* :Min 2 Max 100 Characters.

The user must have hasverification to verify task

# Response

//sucess
{
  "success": true,
  "msg": "Task Verified",
  "params": {...},
  "no": "taskno"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Undo Task Verify

📌 POST:/task/undotaskverify

# Request (Body)

  • taskno* : String Max 10 Characters , only Alpha Numeric

To Undo Task Verify the user must have hasmaster permission .

# Response

//sucess
{
  "success": true,
  "msg": "Task Verified",
  "params": {...},
  "no": "taskno"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Master Update

📌 POST:/task/taskmasterupdate

# request (body)

  • taskno* : String Max 10 Characters , only Alpha Numeric.
  • taskname* : String 3-50 Characters.
  • dtcreate* : Date ISO requiured .
  • isclientvisible* : Conatins only 0 or 1.

Note :

  1. For updating Task the user must have hasadmin permission.
  2. The task TARGET DATE,DUE DATE,COMPLETION DATE must be after the creation date.

# Response

//sucess
{
  "success": true,
  "msg": "Task Updated",
  "params": {...},
  "no": "taskno"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Info Update

📌 POST:/task/taskinfoupdate

# Request (body)

  • taskno* : String Max 10 Characters , only Alpha Numeric.
  • taskstatus : 'G', 'C', 'I', 'S'
  • taskpriority : Only integer between 1 and 5.
  • stuckreason : Max length 200.
  • dttarget, dtdue, dtcomplete : DATE ISO required.

Note :

  1. For changing the Task Info the user must have hastask permission.
  2. If the task is verified the task details cannot be updated.
  3. If the task is complete(C) or stuck(S), then task complete date dtcomplete is required.
  4. If the task is to be marked complete(C), make sure all the stages and todos are completed for that task.
  5. If the task is stuck(S) or ignore(I) a stuckreason is required.

# Response

//sucess
{
  "data": {....},
  "success": true,
  "msg": "Task info Updated"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Billing Info

📌 POST:/task/taskbillinginfo

# Request (body)

  • taskno* : String Max 10 Characters , Only AlphaNumeric.

For the taskbillinginfo the user must have hasmoney Permission .

# Response

//sucess
{
  "data": {...},
  "success": true,
  "team cost" : {....},
  "msg": "Task cost loaded "
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Billing Info Update

📌 POST:/task/taskbillinginfoupdate

# Request (body)

  • taskno* : String Max 10 Characters . Only AlphaNumeric.
  • publicnote : Max 200 characters.
  • privatenote : Max 200 characters.
  • dtbilled : Date ISO standard required .
  • tbamt : Only numbres.
  • tbhour : Only numbres.
  • isbilling : only 0,1,2.

Note :

  1. For updating billing info the user must have hasbilling permission .
  2. dtbilled,tbamt,tbhour stand for date billed , task by amount, task by time respectively.

# Response

//sucess
{
  "success": true,
  "params" : {....},
  "msg": "Task info Updated"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Label Task Add

📌 POST:/task/labeltaskadd

# Request (body)

  • taskno* : String Max 10 Characters . Only AlphaNumeric.
  • labelname* : String. Only AlphaNumeric and - allowed. Min 2 and Max 20 characters allowed

For Adding task label the user must have hastasklabel Permission.

# Response

//sucess
{
  "success": true,
  "params" : {....},
  "no" : "labelno",
  "msg": "label Added"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Label Task Delete

📌 POST:/task/labeltaskdelete

# Request (body)

  • taskno* : String Max 10 Characters . Only AlphaNumeric.
  • labelname* : String. Only AlphaNumeric and - allowed. Min 2 and Max 20 characters allowed

For Adding task label the user must have hastasklabel Permission.

# Response

//sucess
{
  "success": true,
  "params" : {....},
  "msg": "label Deleted"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Team Add

📌 POST:/task/taskteamadd

# Request (body)

  • taskno* : String Max 10 Characters . Only AlphaNumeric.
  • staffmob* : Max 16 characters.

Note :

  1. For Adding task Team the user must have hastaskteam Permission.
  2. If the task is verified the team member cannot be deleted .
  3. For non Indian mobile nos, kindly add country code ex: +1.....

# Response

//sucess
{
  "success": true,
  "params" : {....},
  "no" : "taskno",
  "msg": "Team Member Added"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Task Team Delete

📌 POST:/task/taskteamdelete

# Request (body)

  • taskno* : String Max 10 Characters . Only AlphaNumeric.
  • staffmob* : Max 16 characters.

Note :

  1. For Adding task Team the user must have hastaskteam Permission.
  2. If the task is verified the team member cannot be deleted.
  3. For non Indian mobile nos, kindly add country code ex: +1......

# Response

//sucess
{
  "success": true,
  "params" : {....},
  "no" : "taskno",
  "msg": "Team Member Deleted"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Complaince For Client

# Request (body)

  • clientno* : String Max 10 Characters . Only AlphaNumeric.
  • serviceno* : Only Integer

# Response

//sucess
{
  "success": true,
  "data" : [],
  "msg": "Complaince Loaded"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}
Last Updated: 17 Jul 2020