Routes : Setting
File Name : setting.js
File Path : server/routes/api/settings.js
Setting Contains route which can create, update, view and delete the user details. These functionalities are included in setting Controller.
Get Settings Route
1.API Path:
api/settings
2.Method:
GET
3.Description:
Setting route is used to get all settings.
4.Parameters:
FieldName: req,
Type: Object,
Token:TRUE,
In : Header,
Token-Type: String,
Role: Owner
| Name | Type | Required |
|---|---|---|
| restaurantID | ObjectId | true |
| location | ObjectId | true |
| globalVAT | Number | true |
| loyalityPercentage | Number | true |
| minLoyalityPoints | Number | true |
| loyalityProgram | Boolean | true |
| minOrdLoyality | Number | true |
Response:
Http Code:200
Data:[ ]
Type: Array
| Name | Type |
|---|---|
| statusCode | Number |
| Data | Array |
Description:Data is an Array with a all settings.
Post Settings Route
1.API Path:
api/settings
2.Method:
POST
3.Description:
Settings route is used to create a new setting.
4.Parameters:
FieldName: req,
Type: Object,
Token:TRUE,
In : Header,
Token-Type: String,
Role: Owner
Response:
Http Code:200
Data:{ }
Type: Object
| Name | Type |
|---|---|
| statusCode | Number |
| Data | Object |
Description:Data is an Object with a new created settings.
Update Settings Route
1.API Path:
api/settings/:id
2.Method:
PUT
3.Description:
Settings route is used to update an existing setting.
4.Parameters:
FieldName: req,
Type: Object,
id: req.params.id,
Token:TRUE,
In : Header,
Token-Type: String,
Role: Owner
Response:
Http Code:200
Data:{ }
Type: Object
| Name | Type |
|---|---|
| StatusCode | Number |
| Data | object |
Description:Data is an Object with updating settings.
Delete Settings Route
1.API Path:
api/settings/:id
2.Method:
DELETE
3.Description:
Settings route is used to delete a setting.
4.Parameters:
FieldName: req,
Type: Object,
id:req.params.id,
Token:TRUE,
In : Header,
Token-Type: String,
Role: Owner
Response:
Http Code:200
Data:{ }
Type: Object
| Name | Type |
|---|---|
| statusCode | Number |
| Data | blank Object |
Description:Data is a blank Object.
Get Settings Route
1.API Path:
api/settings/:id
2.Method:
GET
3.Description:
Setting route is used to get all settings.
4.Parameters:
FieldName: req,
Type: Object,
id: req.params.id
Response:
Http Code:200
Data:{ }
Type: Object
| Name | Type |
|---|---|
| statusCode | Number |
| Data | Object |
Description:Data is an Object with a particular setting.