Class CouponservicesController
java.lang.Object
de.hybris.platform.couponwebservices.controllers.CouponservicesController
Couponservices Controller
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateCodeCouponRedemption(CouponRedemptionWsDTO couponRedemptionWsDTO) Request to create a redemption for a coupon with given coupon codeprotected CouponGeneratedCodeWsDTOcreateCouponGeneratedCodeWsDTO(String couponId, MediaModel mediaModel) createMultiCodeCouponWsDTO(MultiCodeCouponWsDTO couponWsDTO) Method to create a new multi-code coupon object given in POST body parameter
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/multicodecoupon Method : POST Header : Content-Type=application/json POST body parameter :{ "couponId" : "COUPON123", "name":"test_multi_coupon", }createSingleCodeCouponWsDTO(SingleCodeCouponWsDTO couponWsDTO) Method to create a new single-code coupon object given in POST body parameter
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/singlecodecoupon Method : POST Header : Content-Type=application/json POST body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon", "maxRedemptionsPerCustomer":"2", "maxTotalRedemptions":"10" }org.springframework.http.HttpEntity<org.springframework.http.HttpHeaders>generateCouponCodes(String couponId, int batchsize) Generate multi-code coupon codesgetCodeGenerationConfiguration(String codeGenerationConfigurationName, String fields) Request to get a code generation configurationprotected CodeGenerationConfigurationWsFacadeprotected CouponCodeGenerationWsFacadeprotected org.springframework.validation.Validatorprotected CouponRedemptionWsFacadeprotected org.springframework.validation.Validatorprotected DataMapperprotected GenericCouponWsFacadesgetMultiCodeCoupon(String couponId, String fields) Request to get a multi-code coupon with given couponIdprotected org.springframework.validation.Validatorprotected CouponWsFacades<MultiCodeCouponWsDTO>getSingleCodeCoupon(String couponId, String fields) Request to get a single-code coupon with given couponIdgetSingleCodeCouponRedemption(String couponId, String customerId, String fields) Request to get a redemption status for a single-code coupon with given couponIdprotected org.springframework.validation.Validatorprotected CouponWsFacades<SingleCodeCouponWsDTO>voidupdateMultiCodeCouponWsDTO(MultiCodeCouponWsDTO couponWsDTO) Method to update a multi-code coupon object given in PUT body parameter
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/multicodecoupon/update Method : PUT Header : Content-Type=application/json PUT body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon" }voidupdateMultiCodeStatusCouponWsDTO(CouponStatusWsDTO couponStatusWsDTO) Method to update a multi-code coupon status
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/multicodecoupon/update/status Method : PUT PUT body parametersvoidupdateSingleCodeCouponWsDTO(SingleCodeCouponWsDTO couponWsDTO) Method to update a single-code coupon object given in PUT body parameter
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/singlecodecoupon/update Method : PUT Header : Content-Type=application/json PUT body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon", "maxRedemptionsPerCustomer":"2", "maxTotalRedemptions":"10" }voidupdateSingleCodeStatusCouponWsDTO(CouponStatusWsDTO couponStatusWsDTO) Method to update a single-code coupon status
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/singlecodecoupon/update/status Method : PUT PUT body parametersprotected voidValidates the object by using the passed validatorvalidateCoupon(String couponCode, String customerId, String fields) Request to validate a coupon with given coupon codevalidateMultiCodeCoupon(String couponCode, String fields) Deprecated, for removal: This API element is subject to removal in a future version.since 2005, forRemoval = true use {@link de.hybris.platform.couponwebservices.controllers.validateCoupon()} instead Request to validate a multi-code coupon with given couponIdvalidateSingleCodeCoupon(String couponId, String customerId, String fields) Deprecated, for removal: This API element is subject to removal in a future version.since 2205, forRemoval = ture, use {@link de.hybris.platform.couponwebservices.controllers.validateCoupon()} instead Request to validate a single-code coupon with given couponId
-
Field Details
-
DEFAULT_FIELD_SET
- See Also:
-
DEFAULT_CURRENT_PAGE
- See Also:
-
DEFAULT_PAGE_SIZE
- See Also:
-
DEFAULT_SORT
- See Also:
-
URL_V2
- See Also:
-
-
Constructor Details
-
CouponservicesController
public CouponservicesController()
-
-
Method Details
-
createSingleCodeCouponWsDTO
@PostMapping(value="/v2/singlecodecoupon/create", produces={"application/json","application/xml"}, consumes={"application/json","application/xml"}) @ResponseStatus(CREATED) @ResponseBody public SingleCodeCouponWsDTO createSingleCodeCouponWsDTO(@RequestBody SingleCodeCouponWsDTO couponWsDTO) Method to create a new single-code coupon object given in POST body parameter
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/singlecodecoupon Method : POST Header : Content-Type=application/json POST body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon", "maxRedemptionsPerCustomer":"2", "maxTotalRedemptions":"10" }- Parameters:
couponWsDTO- - Request body parameter (DTO in xml or json format)- Returns:
- - instance of SingleCodeCouponWsDTO, that was saved in the system
-
updateSingleCodeStatusCouponWsDTO
@PutMapping(value="/v2/singlecodecoupon/update/status", consumes={"application/json","application/xml"}) @ResponseStatus(NO_CONTENT) @ResponseBody public void updateSingleCodeStatusCouponWsDTO(@RequestBody CouponStatusWsDTO couponStatusWsDTO) Method to update a single-code coupon status
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/singlecodecoupon/update/status Method : PUT PUT body parameters- Parameters:
couponStatusWsDTO- - request object containing couponId and active attributes
-
updateMultiCodeStatusCouponWsDTO
@PutMapping(value="/v2/multicodecoupon/update/status", consumes={"application/json","application/xml"}) @ResponseStatus(NO_CONTENT) @ResponseBody public void updateMultiCodeStatusCouponWsDTO(@RequestBody CouponStatusWsDTO couponStatusWsDTO) Method to update a multi-code coupon status
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/multicodecoupon/update/status Method : PUT PUT body parameters- Parameters:
couponStatusWsDTO- - request object containing couponId and active attributes
-
updateSingleCodeCouponWsDTO
@PutMapping(value="/v2/singlecodecoupon/update", consumes={"application/json","application/xml"}) @ResponseStatus(NO_CONTENT) @ResponseBody public void updateSingleCodeCouponWsDTO(@RequestBody SingleCodeCouponWsDTO couponWsDTO) Method to update a single-code coupon object given in PUT body parameter
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/singlecodecoupon/update Method : PUT Header : Content-Type=application/json PUT body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon", "maxRedemptionsPerCustomer":"2", "maxTotalRedemptions":"10" }- Parameters:
couponWsDTO- - Request body parameter (DTO in xml or json format)
-
updateMultiCodeCouponWsDTO
@PutMapping(value="/v2/multicodecoupon/update", consumes={"application/json","application/xml"}) @ResponseStatus(NO_CONTENT) @ResponseBody public void updateMultiCodeCouponWsDTO(@RequestBody MultiCodeCouponWsDTO couponWsDTO) Method to update a multi-code coupon object given in PUT body parameter
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/multicodecoupon/update Method : PUT Header : Content-Type=application/json PUT body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon" }- Parameters:
couponWsDTO- - Request body parameter (DTO in xml or json format)
-
createMultiCodeCouponWsDTO
@PostMapping(value="/v2/multicodecoupon/create", produces="application/json", consumes={"application/json","application/xml"}) @ResponseStatus(CREATED) @ResponseBody public MultiCodeCouponWsDTO createMultiCodeCouponWsDTO(@RequestBody MultiCodeCouponWsDTO couponWsDTO) Method to create a new multi-code coupon object given in POST body parameter
Example : URL : http://localhost:9001/couponwebservices/couponservices/v2/multicodecoupon Method : POST Header : Content-Type=application/json POST body parameter :{ "couponId" : "COUPON123", "name":"test_multi_coupon", }- Parameters:
couponWsDTO- - Request body parameter (DTO in xml or json format)- Returns:
- - instance of
MultiCodeCouponWsDTO, that was saved in the system
-
getSingleCodeCoupon
@GetMapping(value="/v2/singlecodecoupon/get/{couponId}", produces={"application/json","application/xml"}) @ResponseBody public SingleCodeCouponWsDTO getSingleCodeCoupon(@PathVariable String couponId, @RequestParam(required=false,defaultValue="DEFAULT") String fields) Request to get a single-code coupon with given couponId- Parameters:
couponId- the couponId of the requested couponfields- defaulted to DEFAULT but can be FULL or BASIC- Returns:
- instance of
SingleCodeCouponWsDTO, corresponding tocouponId
-
validateSingleCodeCoupon
@Deprecated(since="2205", forRemoval=true) @GetMapping(value="/v2/singlecodecoupon/validate/{couponId}", produces="application/json") @ResponseBody public CouponValidationResponseWsDTO validateSingleCodeCoupon(@PathVariable String couponId, @RequestParam(required=false) String customerId, @RequestParam(required=false,defaultValue="DEFAULT") String fields) Deprecated, for removal: This API element is subject to removal in a future version.since 2205, forRemoval = ture, use {@link de.hybris.platform.couponwebservices.controllers.validateCoupon()} instead Request to validate a single-code coupon with given couponId- Parameters:
couponId- the couponId of the requested couponcustomerId- the user idfields- defaulted to DEFAULT but can be FULL or BASIC- Returns:
- instance of
SingleCodeCouponWsDTO, corresponding tocouponId
-
getMultiCodeCoupon
@GetMapping(value="/v2/multicodecoupon/get/{couponId}", produces={"application/json","application/xml"}) @ResponseBody public MultiCodeCouponWsDTO getMultiCodeCoupon(@PathVariable String couponId, @RequestParam(required=false,defaultValue="DEFAULT") String fields) Request to get a multi-code coupon with given couponId- Parameters:
couponId- the couponId of the requested couponfields- defaulted to DEFAULT but can be FULL or BASIC- Returns:
- instance of
MultiCodeCouponWsDTO, corresponding tocouponId
-
createCouponGeneratedCodeWsDTO
protected CouponGeneratedCodeWsDTO createCouponGeneratedCodeWsDTO(String couponId, MediaModel mediaModel) -
validateMultiCodeCoupon
@Deprecated(since="2205", forRemoval=true) @GetMapping(value="/v2/multicodecoupon/validate/{couponCode}", produces="application/json") @ResponseBody public CouponValidationResponseWsDTO validateMultiCodeCoupon(@PathVariable String couponCode, @RequestParam(required=false,defaultValue="DEFAULT") String fields) Deprecated, for removal: This API element is subject to removal in a future version.since 2005, forRemoval = true use {@link de.hybris.platform.couponwebservices.controllers.validateCoupon()} instead Request to validate a multi-code coupon with given couponId- Parameters:
couponCode- the couponCode of the requested couponfields- defaulted to DEFAULT but can be FULL or BASIC- Returns:
- instance of
CouponValidationResponseWsDTO, corresponding tocouponCode
-
generateCouponCodes
@PutMapping(value="/v2/multicodecoupon/generate/{couponId}/{batchsize}", produces="application/json") @ResponseBody public org.springframework.http.HttpEntity<org.springframework.http.HttpHeaders> generateCouponCodes(@PathVariable("couponId") String couponId, @PathVariable("batchsize") int batchsize) Generate multi-code coupon codes- Parameters:
couponId- the couponId of related MultiCodeCouponbatchsize- batch size for generated coupons- Returns:
- a link to a generated coupons resource
-
getSingleCodeCouponRedemption
@GetMapping(value="/v2/singlecodecouponredemption/get/{couponId}", produces={"application/json","application/xml"}) @ResponseBody public CouponRedemptionWsDTO getSingleCodeCouponRedemption(@PathVariable String couponId, @RequestParam(required=false) String customerId, @RequestParam(required=false,defaultValue="DEFAULT") String fields) Request to get a redemption status for a single-code coupon with given couponId- Parameters:
couponId- the couponId of the requested couponcustomerId- the user idfields- defaulted to DEFAULT but can be FULL or BASIC- Returns:
- instance of
CouponRedemptionWsDTO, corresponding tocouponId
-
getCodeGenerationConfiguration
@GetMapping(value="/v2/codegenerationconfiguration/get/{codeGenerationConfigurationName}", produces={"application/json","application/xml"}) @ResponseBody public CodeGenerationConfigurationWsDTO getCodeGenerationConfiguration(@PathVariable String codeGenerationConfigurationName, @RequestParam(required=false,defaultValue="DEFAULT") String fields) Request to get a code generation configuration- Parameters:
codeGenerationConfigurationName- the codeGenerationConfigurationName of the requested codeGenerationConfigurationfields- defaulted to DEFAULT but can be FULL or BASIC- Returns:
- instance of
CodeGenerationConfigurationWsDTO, corresponding tocodeGenerationConfigurationName
-
createCodeCouponRedemption
@PostMapping(value="/v2/couponredemption/create", produces="application/json", consumes={"application/json","application/xml"}) @ResponseStatus(CREATED) @ResponseBody public CouponRedemptionWsDTO createCodeCouponRedemption(@RequestBody CouponRedemptionWsDTO couponRedemptionWsDTO) Request to create a redemption for a coupon with given coupon code- Returns:
- instance of CouponRedemption
-
validateCoupon
@GetMapping(value="/v2/coupon/validate/{couponCode}", produces="application/json") @ResponseBody public CouponValidationResponseWsDTO validateCoupon(@PathVariable String couponCode, @RequestParam(required=false) String customerId, @RequestParam(required=false,defaultValue="DEFAULT") String fields) Request to validate a coupon with given coupon code- Parameters:
couponCode- the couponCode of the requested couponcustomerId- the user idfields- defaulted to DEFAULT but can be FULL or BASIC- Returns:
- instance of
SingleCodeCouponWsDTO, corresponding tocouponId
-
validate
protected void validate(Object object, String objectName, org.springframework.validation.Validator validator) Validates the object by using the passed validator- Parameters:
object- the object ot be validatedobjectName- the object namevalidator- validator which will validate the object
-
getDataMapper
-
getSingleCodeCouponWsFacades
-
getDefaultGenericCouponWsFacades
-
getSingleCodeCouponWsDTOValidator
protected org.springframework.validation.Validator getSingleCodeCouponWsDTOValidator() -
getCouponStatusWsDTOValidator
protected org.springframework.validation.Validator getCouponStatusWsDTOValidator() -
getMultiCodeCouponWsDTOValidator
protected org.springframework.validation.Validator getMultiCodeCouponWsDTOValidator() -
getCouponRedemptionWsDTOValidator
protected org.springframework.validation.Validator getCouponRedemptionWsDTOValidator() -
getMultiCodeCouponWsFacades
-
getCouponCodeGenerationWsFacade
-
getCouponRedemptionWsFacade
-
getCodeGenerationConfigurationWsFacade
-