Routes - AppConfig
File Name : appConfig.js
File Path : /server/routes/appConfig.js
appConfig route contains getConfig, updateAppConfig. These functionalities are included in appConfig Controller.
Get App Config
- API Path: api/appConfig/getAppConfig
- Method: GET
- Description: In this route gets the all appConfigs.
Parameters:
- Name: req
- Type: Object
Name: res
- Type: Object
- Description: res is nothing but the response object which gets you the appConfig details.
Response:
- Http Code: 200
- Name: returnObj
- Type: Object
Name Type success boolean message string data array
Update AppConfig Route For Admin
- API Path: api/appConfig/updateAppConfig
- Method: PUT
- Description: This is a protected route which gets the user details through JWT access token which is provided in the header.
Parameters:
- Name: req
- Type: Object
Name In Type key req.body string value req.body boolean/string - Name: jwtAccessToken
- In: Header
- Type: String
- Description: JWT access token is used to check the authenticity of the user.
Name: res
- Type: Object
- Description: res is nothing but the response object which gets you the updated config.
Response:
- Http Code: 200
- Name: returnObj
- Type: Object
Name Type success boolean message string data object