de.hybris.platform.ycommercewebservices.v1.controller

Class CustomerGroupsController

java.lang.Object

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

de.hybris.platform.ycommercewebservices.v1.controller.CustomerGroupsController

public class CustomerGroupsController
extends BaseController

Controller for CustomerGroupFacade

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
CustomerGroupsController()

Method Summary

Modifier and Type	Method and Description
void	assignUserToCustomerGroup(java.lang.String customerGroupUid, java.util.List<java.lang.String> members) Web service for assigning user to a customer group. Sample call: https://localhost:9002/rest/v1/mysite/customergroups/{groupId}/members Method requires authentication and is restricted HTTPS channel. Method type : PUT.
void	createNewCustomerGroup(java.lang.String uid, java.lang.String localizedName) Web service for creating new customer group. Sample call: https://localhost:9002/rest/v1/mysite/customergroups Method requires authentication and is restricted HTTPS channel. Method type : POST.
UserGroupDataList	getAllCustomerGroups(int currentPage, int pageSize) Web service for getting all customer groups. Sample call: https://localhost:9002/rest/v1/mysite/customergroups Method requires authentication and is restricted HTTPS channel. Method type : GET.
UserGroupData	getCustomerGroup(java.lang.String uid, java.lang.String options)
protected java.util.Set<UserGroupOption>	getOptions(java.lang.String options)
void	removeUsersFromCustomerGroup(java.lang.String customerGroupUid, java.lang.String userId)

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

CustomerGroupsController

public CustomerGroupsController()

Method Detail

createNewCustomerGroup

public void createNewCustomerGroup(java.lang.String uid,
                                   java.lang.String localizedName)

Web service for creating new customer group.
Sample call: https://localhost:9002/rest/v1/mysite/customergroups
Method requires authentication and is restricted HTTPS channel.
Method type : POST.
Method response with 201 Created.

assignUserToCustomerGroup

public void assignUserToCustomerGroup(java.lang.String customerGroupUid,
                                      java.util.List<java.lang.String> members)

Web service for assigning user to a customer group.
Sample call: https://localhost:9002/rest/v1/mysite/customergroups/{groupId}/members
Method requires authentication and is restricted HTTPS channel.
Method type : PUT.
Members ids must be given as put body

removeUsersFromCustomerGroup

public void removeUsersFromCustomerGroup(java.lang.String customerGroupUid,
                                         java.lang.String userId)

getAllCustomerGroups

public UserGroupDataList getAllCustomerGroups(int currentPage,
                                              int pageSize)

Web service for getting all customer groups.
Sample call: https://localhost:9002/rest/v1/mysite/customergroups
Method requires authentication and is restricted HTTPS channel.
Method type : GET.
Method handles optional paging parameters:

Parameters:

currentPage -

pageSize -

Returns:

UserGroupDataList

getCustomerGroup

public UserGroupData getCustomerGroup(java.lang.String uid,
                                      java.lang.String options)

getOptions

protected java.util.Set<UserGroupOption> getOptions(java.lang.String options)