Package de.hybris.platform.couponwebservices.controllers

Class CouponservicesController

  • @Controller
@RequestMapping("/couponservices")
public class CouponservicesController
extends java.lang.Object
    Couponservices Controller

    • Constructor Detail

      • CouponservicesController

        public CouponservicesController()

    • Method Detail

      • createSingleCodeCouponWsDTO

        @RequestMapping(value="/v2/singlecodecoupon/create",
                method=POST)
@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

        @RequestMapping(value="/v2/singlecodecoupon/update/status",
                method=PUT)
@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

        @RequestMapping(value="/v2/multicodecoupon/update/status",
                method=PUT)
@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

        @RequestMapping(value="/v2/singlecodecoupon/update",
                method=PUT)
@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

        @RequestMapping(value="/v2/multicodecoupon/update",
                method=PUT)
@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

        @RequestMapping(value="/v2/multicodecoupon/create",
                method=POST)
@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

        @RequestMapping(value="/v2/singlecodecoupon/get/{couponId}",
                method=GET)
@ResponseBody
public SingleCodeCouponWsDTO getSingleCodeCoupon​(@PathVariable
                                                 java.lang.String couponId,
                                                 @RequestParam(required=false,defaultValue="DEFAULT")
                                                 java.lang.String fields)
        Request to get a single-code coupon with given couponId
        Parameters:
        couponId - the couponId of the requested coupon
        fields - defaulted to DEFAULT but can be FULL or BASIC
        Returns:
        instance of SingleCodeCouponWsDTO, corresponding to couponId

      • validateSingleCodeCoupon

        @RequestMapping(value="/v2/singlecodecoupon/validate/{couponId}",
                method=GET)
@ResponseBody
public CouponValidationResponseWsDTO validateSingleCodeCoupon​(@PathVariable
                                                              java.lang.String couponId,
                                                              @RequestParam(required=false)
                                                              java.lang.String customerId,
                                                              @RequestParam(required=false,defaultValue="DEFAULT")
                                                              java.lang.String fields)
        Request to validate a single-code coupon with given couponId
        Parameters:
        couponId - the couponId of the requested coupon
        customerId - the user id
        fields - defaulted to DEFAULT but can be FULL or BASIC
        Returns:
        instance of SingleCodeCouponWsDTO, corresponding to couponId

      • getMultiCodeCoupon

        @RequestMapping(value="/v2/multicodecoupon/get/{couponId}",
                method=GET)
@ResponseBody
public MultiCodeCouponWsDTO getMultiCodeCoupon​(@PathVariable
                                               java.lang.String couponId,
                                               @RequestParam(required=false,defaultValue="DEFAULT")
                                               java.lang.String fields)
        Request to get a multi-code coupon with given couponId
        Parameters:
        couponId - the couponId of the requested coupon
        fields - defaulted to DEFAULT but can be FULL or BASIC
        Returns:
        instance of MultiCodeCouponWsDTO, corresponding to couponId

      • validateMultiCodeCoupon

        @RequestMapping(value="/v2/multicodecoupon/validate/{couponCode}",
                method=GET)
@ResponseBody
public CouponValidationResponseWsDTO validateMultiCodeCoupon​(@PathVariable
                                                             java.lang.String couponCode,
                                                             @RequestParam(required=false,defaultValue="DEFAULT")
                                                             java.lang.String fields)
        Request to validate a multi-code coupon with given couponId
        Parameters:
        couponCode - the couponCode of the requested coupon
        fields - defaulted to DEFAULT but can be FULL or BASIC
        Returns:
        instance of CouponValidationResponseWsDTO, corresponding to couponCode

      • generateCouponCodes

        @RequestMapping(value="/v2/multicodecoupon/generate/{couponId}/{batchsize}",
                method=PUT)
@ResponseBody
public org.springframework.http.HttpEntity<org.springframework.http.HttpHeaders> generateCouponCodes​(@PathVariable("couponId")
                                                                                                     java.lang.String couponId,
                                                                                                     @PathVariable("batchsize")
                                                                                                     int batchsize)
        Generate multi-code coupon codes
        Parameters:
        couponId - the couponId of related MultiCodeCoupon
        batchsize - batch size for generated coupons
        Returns:
        a link to a generated coupons resource

      • getSingleCodeCouponRedemption

        @RequestMapping(value="/v2/singlecodecouponredemption/get/{couponId}",
                method=GET)
@ResponseBody
public CouponRedemptionWsDTO getSingleCodeCouponRedemption​(@PathVariable
                                                           java.lang.String couponId,
                                                           @RequestParam(required=false)
                                                           java.lang.String customerId,
                                                           @RequestParam(required=false,defaultValue="DEFAULT")
                                                           java.lang.String fields)
        Request to get a redemption status for a single-code coupon with given couponId
        Parameters:
        couponId - the couponId of the requested coupon
        customerId - the user id
        fields - defaulted to DEFAULT but can be FULL or BASIC
        Returns:
        instance of CouponRedemptionWsDTO, corresponding to couponId

      • getCodeGenerationConfiguration

        @RequestMapping(value="/v2/codegenerationconfiguration/get/{codeGenerationConfigurationName}",
                method=GET)
@ResponseBody
public CodeGenerationConfigurationWsDTO getCodeGenerationConfiguration​(@PathVariable
                                                                       java.lang.String codeGenerationConfigurationName,
                                                                       @RequestParam(required=false,defaultValue="DEFAULT")
                                                                       java.lang.String fields)
        Request to get a single-code coupon with given couponId
        Parameters:
        codeGenerationConfigurationName - the codeGenerationConfigurationName of the requested codeGenerationConfiguration
        fields - defaulted to DEFAULT but can be FULL or BASIC
        Returns:
        instance of CodeGenerationConfigurationWsDTO, corresponding to codeGenerationConfigurationName

      • validate

        protected void validate​(java.lang.Object object,
                        java.lang.String objectName,
                        org.springframework.validation.Validator validator)
        Validates the object by using the passed validator
        Parameters:
        object - the object ot be validated
        objectName - the object name
        validator - validator which will validate the object

      • getDataMapper

        protected DataMapper getDataMapper()

      • getSingleCodeCouponWsDTOValidator

        protected org.springframework.validation.Validator getSingleCodeCouponWsDTOValidator()

      • getCouponStatusWsDTOValidator

        protected org.springframework.validation.Validator getCouponStatusWsDTOValidator()

      • getMultiCodeCouponWsDTOValidator

        protected org.springframework.validation.Validator getMultiCodeCouponWsDTOValidator()