Class CouponservicesController

java.lang.Object
de.hybris.platform.couponwebservices.controllers.CouponservicesController

@Controller @RequestMapping("/couponservices") public class CouponservicesController extends Object
Couponservices Controller
  • Field Details

  • 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 coupon
      fields - defaulted to DEFAULT but can be FULL or BASIC
      Returns:
      instance of SingleCodeCouponWsDTO, corresponding to couponId
    • 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 coupon
      customerId - the user id
      fields - defaulted to DEFAULT but can be FULL or BASIC
      Returns:
      instance of SingleCodeCouponWsDTO, corresponding to couponId
    • 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 coupon
      fields - defaulted to DEFAULT but can be FULL or BASIC
      Returns:
      instance of MultiCodeCouponWsDTO, corresponding to couponId
    • 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 coupon
      fields - defaulted to DEFAULT but can be FULL or BASIC
      Returns:
      instance of CouponValidationResponseWsDTO, corresponding to couponCode
    • 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 MultiCodeCoupon
      batchsize - 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 coupon
      customerId - the user id
      fields - defaulted to DEFAULT but can be FULL or BASIC
      Returns:
      instance of CouponRedemptionWsDTO, corresponding to couponId
    • 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 codeGenerationConfiguration
      fields - defaulted to DEFAULT but can be FULL or BASIC
      Returns:
      instance of CodeGenerationConfigurationWsDTO, corresponding to codeGenerationConfigurationName
    • 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 coupon
      customerId - the user id
      fields - defaulted to DEFAULT but can be FULL or BASIC
      Returns:
      instance of SingleCodeCouponWsDTO, corresponding to couponId
    • 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 validated
      objectName - the object name
      validator - validator which will validate the object
    • getDataMapper

      protected DataMapper getDataMapper()
    • getSingleCodeCouponWsFacades

      protected CouponWsFacades<SingleCodeCouponWsDTO> getSingleCodeCouponWsFacades()
    • getDefaultGenericCouponWsFacades

      protected GenericCouponWsFacades 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

      protected CouponWsFacades<MultiCodeCouponWsDTO> getMultiCodeCouponWsFacades()
    • getCouponCodeGenerationWsFacade

      protected CouponCodeGenerationWsFacade getCouponCodeGenerationWsFacade()
    • getCouponRedemptionWsFacade

      protected CouponRedemptionWsFacade getCouponRedemptionWsFacade()
    • getCodeGenerationConfigurationWsFacade

      protected CodeGenerationConfigurationWsFacade getCodeGenerationConfigurationWsFacade()