de.hybris.platform.ycommercewebservices.v1.controller

Class VouchersController

java.lang.Object

de.hybris.platform.ycommercewebservices.v1.controller.BaseController

de.hybris.platform.ycommercewebservices.v1.controller.VouchersController

public class VouchersController
extends BaseController

Main Controller for Vouchers

Field Summary

Fields inherited from class de.hybris.platform.ycommercewebservices.v1.controller.BaseController

DEFAULT_CURRENT_PAGE, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
VouchersController()

Method Summary

Modifier and Type	Method and Description
VoucherData	getVoucherByCode(java.lang.String code) Web service for getting voucher information by voucher code. Sample call: https://localhost:9002/rest/v1/mysite/vouchers/abc-9PSW-EDH2-RXKA This method requires authentication. Method type : GET. Method is restricted for HTTPS channel.

Methods inherited from class de.hybris.platform.ycommercewebservices.v1.controller.BaseController

handleErrorInternal, handleModelNotFoundException, sanitize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VouchersController

public VouchersController()

Method Detail

getVoucherByCode

public VoucherData getVoucherByCode(java.lang.String code)
                             throws VoucherOperationException

Web service for getting voucher information by voucher code.
Sample call: https://localhost:9002/rest/v1/mysite/vouchers/abc-9PSW-EDH2-RXKA
This method requires authentication.
Method type : GET.
Method is restricted for HTTPS channel.

Parameters:

code - - voucher code - must be given as path variable.

Returns:

VoucherData which will be marshaled to JSON or XML based on Accept-Header

Throws:

VoucherOperationException - if voucher cannot be found