Package de.hybris.platform.warehousingwebservices.controllers.stocklevel

Class WarehousingStockLevelsController

java.lang.Object

de.hybris.platform.warehousingwebservices.controllers.WarehousingBaseController

de.hybris.platform.warehousingwebservices.controllers.stocklevel.WarehousingStockLevelsController

@Controller
@RequestMapping("/stocklevels")
public class WarehousingStockLevelsController
extends WarehousingBaseController

WebResource exposing WarehousingStockLevelFacade http://host:port/warehousingwebservices/stocklevels

Field Summary

Fields inherited from class de.hybris.platform.warehousingwebservices.controllers.WarehousingBaseController

dataMapper, DEFAULT_CURRENT_PAGE, DEFAULT_FIELD_SET, DEFAULT_PAGE_SIZE, DEFAULT_SORT, WAREHOUSE_ADMINISTRATOR_GROUP, WAREHOUSE_AGENT_GROUP, WAREHOUSE_MANAGER_GROUP

Constructor Summary

Constructors

Constructor	Description
WarehousingStockLevelsController()

Method Summary

Modifier and Type	Method	Description
StockLevelWsDto	createStockLevel(StockLevelWsDto stockLevelWsDto, java.lang.String fields)	Request to create a StockLevelModel in the system
StockLevelAdjustmentsWsDTO	createStockLevelAdjustment(java.lang.String productCode, java.lang.String warehouseCode, java.lang.String binCode, java.lang.String releaseDate, StockLevelAdjustmentsWsDTO stockLevelAdjustmentsWsDTO)	Request to create a InventoryEventModel in the system to adjust a specific StockLevelModel
StockLevelAdjustmentReasonsWsDTO	getStockLevelAdjustmentReasons()	Request to get return stock level adjustment reasons
StockLevelSearchPageWsDto	getStockLevelsForWarehouseCode(java.lang.String code, java.lang.String fields, int currentPage, int pageSize, java.lang.String sort)	Request to get a StockLevelModel for its "code"

Methods inherited from class de.hybris.platform.warehousingwebservices.controllers.WarehousingBaseController

createPageable, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

WarehousingStockLevelsController

public WarehousingStockLevelsController()

Method Detail

getStockLevelsForWarehouseCode

@Secured({"ROLE_WAREHOUSEAGENTGROUP","ROLE_WAREHOUSEMANAGERGROUP","ROLE_WAREHOUSEADMINISTRATORGROUP"})
@RequestMapping(value="/warehouses/{code}",
                method=GET)
@ResponseBody
public StockLevelSearchPageWsDto getStockLevelsForWarehouseCode(@PathVariable
                                                                java.lang.String code,
                                                                @RequestParam(required=false,defaultValue="DEFAULT")
                                                                java.lang.String fields,
                                                                @RequestParam(required=false,defaultValue="0")
                                                                int currentPage,
                                                                @RequestParam(required=false,defaultValue="10")
                                                                int pageSize,
                                                                @RequestParam(required=false,defaultValue="asc")
                                                                java.lang.String sort)

Request to get a StockLevelModel for its "code"

Parameters:

code - the code of the requested WarehouseModel

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

the list of stocklevels

createStockLevel

@Secured({"ROLE_WAREHOUSEAGENTGROUP","ROLE_WAREHOUSEMANAGERGROUP","ROLE_WAREHOUSEADMINISTRATORGROUP"})
@RequestMapping(method=POST,
                produces={"application/json","application/xml"},
                consumes={"application/json","application/xml"})
@ResponseStatus(CREATED)
@ResponseBody
public StockLevelWsDto createStockLevel(@RequestBody
                                        StockLevelWsDto stockLevelWsDto,
                                        @RequestParam(required=false,defaultValue="DEFAULT")
                                        java.lang.String fields)
                                 throws WebserviceValidationException

Request to create a StockLevelModel in the system

Parameters:

fields - defaulted to DEFAULT but can be FULL or BASIC

stockLevelWsDto - object representing StockLevelWsDto

Returns:

created stockLevel

Throws:

WebserviceValidationException

getStockLevelAdjustmentReasons

@Secured({"ROLE_WAREHOUSEAGENTGROUP","ROLE_WAREHOUSEMANAGERGROUP","ROLE_WAREHOUSEADMINISTRATORGROUP"})
@RequestMapping(value="/adjustment-reasons",
                method=GET)
@ResponseBody
public StockLevelAdjustmentReasonsWsDTO getStockLevelAdjustmentReasons()

Request to get return stock level adjustment reasons

Returns:

list of stock level adjustment reason

createStockLevelAdjustment

@Secured({"ROLE_WAREHOUSEAGENTGROUP","ROLE_WAREHOUSEMANAGERGROUP","ROLE_WAREHOUSEADMINISTRATORGROUP"})
@RequestMapping(value="/product/{productCode}/warehouse/{warehouseCode}/adjustment",
                method=POST,
                produces={"application/json","application/xml"},
                consumes={"application/json","application/xml"})
@ResponseStatus(CREATED)
@ResponseBody
public StockLevelAdjustmentsWsDTO createStockLevelAdjustment(@PathVariable
                                                             java.lang.String productCode,
                                                             @PathVariable
                                                             java.lang.String warehouseCode,
                                                             @RequestParam(required=false)
                                                             java.lang.String binCode,
                                                             @RequestParam(required=false)
                                                             java.lang.String releaseDate,
                                                             @RequestBody
                                                             StockLevelAdjustmentsWsDTO stockLevelAdjustmentsWsDTO)
                                                      throws WebserviceValidationException

Request to create a InventoryEventModel in the system to adjust a specific StockLevelModel

Parameters:

productCode - the product code for which an adjustment is required

warehouseCode - the warehouse code for which an adjustment is required

binCode - the bin code of the stock level to adjust (optional)

releaseDate - the release date of the stock level to adjust (optional)

stockLevelAdjustmentsWsDTO - list of stock level adjustment to be created

Returns:

created stockLevel

Throws:

WebserviceValidationException