# Folder

📌 POST:/client/foldersearch

# Requset (body)

  • isforeceget* : Only 0,1 allowed.
  • rf : only 0,1,2.
  • clientnos* : Alpha Numeric,Max 10 Characters.
  • foldertypes : Array Only.
  • foldertypes.* : Invalid Folder Type.
  • folderids* : Only Numbers.
  • isdeleted : Array Only , Contains Only 0 or 1.
  • dtexpiry : Array Only, Max 2 Values.
  • dtexpiry.* : Date (ISO format required).

# Response

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

# Folder Create

📌 POST:/client/foldercreate

# Requset (body)

  • foltype* : Contains 'F', 'D', 'R', 'B', 'O'.
  • clientid* : Only Alpha Numeric,Min 2 and max 10 characters.
  • folderno* : Min 2 and max 10 characters.
  • folname* : Min 2 and max 10 characters.
  • foldescp* : Min 2 and max 10 characters.
  • location : Min 2 and max 10 characters.
  • dtexp : Valid Date (ISO Format Required).
  • category pcenter ccenter : Category name can only contain alphabets, numbers and '-' and '_'.

Note :

  1. For creating a folder the user must have hasfolder Permission.
  2. dtexp , pcenter, ccenter Stand for Expiry date, profit centre , cost centre respectively.

# Response

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

# Folder Update

📌 POST:/client/folderupdate

# Requset (body)

  • folderid* : Only Numbers.
  • foltype* : Contains 'F', 'D', 'R', 'B', 'O'.
  • folname* : Min 2 and max 10 characters.
  • foldescp* : Min 2 and max 10 characters.
  • location : Min 2 and max 10 characters.
  • dtexp : Valid Date (ISO Format Required).
  • category pcenter ccenter : Category name can only contain alphabets, numbers and '-' and '_'.
  • dtdel : Date (ISO format required ).
  • delreason : Min 2 and max 200 characters.

Note :

  1. For creating a folder the user must have hasfolder Permission.
  2. dtexp , dtdel , pcenter, ccenter , delreason Stand for Expiry date , Delete Date , profit centre , cost centre , Delete reason respectively.

# Response

// Success
{
 "success":true,
 "params" : {...} ,
 "msg": "Folders Upadted"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Folder Info

📌 POST:/client/folderifo

# Request (body)

  • folderid* : Only Numbers.

# Response

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

# Folder Delete

📌 POST:/client/folderdelete

# Request (body)

  • folderid* : Only Numbers.

Note :

  1. For deleteing a folder the user must have hasdelete Permission.

# Response

// Success
{
 "success":true,
 "params" : {...} ,
 "msg": "Folders Deleted"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}
Last Updated: 30 Jul 2020