Routes : Coupon
File Name : coupon.js
File Path : server/routes/api/coupon.js
Contains route which can create, update, view and delete the user details. These functionalities are included in Coupan Controller.
Post Coupons Route
1.API Path:
api/coupons
2.Method:
POST
3.Description:
Coupons route is used to create a new coupon.
4.Parameters:
Name: req
Type: Object
| Name | Type | Required | | :--- | :--- | :--- | | restaurantID | ObjectId | true | | location | ObjectId | true | | enable | Boolean | true | | couponName | String | true | | offPrecentage | Number | true | | applicableTo | String | true | | applicableFrom | String | true | | applicableToTimeStamp | Number | true | | applicableFromTimeStamp | Number | true | | description | String | true |
Response:
Http Code:200
Data:{ }
Type: Object
| Name | Type |
|---|---|
| statusCode | Number |
| Data | Object |
Description:Data is an Object with an coupon.
Get Coupons Route
1.API Path:
api/coupons
2.Method:
GET
3.Description:
Coupons route is used to get all coupons.
4.Parameters:
Name: req
Type: Object
Response:
Http Code:200
Data:[ ]
Type: Array
| Name | Type |
|---|---|
| StatusCode | Number |
| Data | Array |
Description:Data is an Array with all coupons.
Get Coupons(particular coupon) Route
1.API Path:
api/coupons/single/:id
2.Method:
GET
3.Description: Coupons route is used to get particular coupon.
4.Parameters:
Name: 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 particular coupon.
Get Coupon(particular locationID) Route
1.API Path:
api/coupons/:id
2.Method:
GET
3.Description: Coupons route is used to get particular coupon based on loctionID.
4.Parameters:
Name: 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 particular coupon.
Update Coupons Route
1.API Path:
api/coupons/:id
2.Method:
PUT
3.Description: Coupons route is used to update particular coupon.
4.Parameters:
Name: 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 particular coupon.
Delete Coupons Route
1.API Path:
api/coupons/:id
2.Method:
DELETE
3.Description: Coupons route is used to delete particular coupon.
4.Parameters:
Name: req,
Type: Object,
id: req.params.id
Response:
Http Code:200
Data:{ }
Type: Object
| Name | Type |
|---|---|
| StatusCode | Number |
| Data | blank Object |
Description:Data is a blank Object.
Get Coupons Route
1.API Path:
api/coupons/validcoupon/bycurrenttimestamp/:id
2.Method:
DELETE
3.Description: Coupons route is used to know that coupon is valid or not based on locationID .
4.Parameters:
Name: req,
Type: Object,
id: req.params.id(locationID)
Response:
Http Code:200
Data:{ }
Type: Object
| Name | Type |
|---|---|
| statusCode | Number |
| Data | Object |
Description:Data is a Object with Coupon.