Package org.openwms.wms.location.api

Interface LocationApi

@FeignClient(name="wms-inventory",
             qualifiers="wmsLocationApi",
             dismiss404=true)
public interface LocationApi

A LocationApi deals with Locations.

Author:

Heiko Scherrer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_LOCATIONS	API root to hit Locations (plural).
static final String	API_VERSION	API version.

Method Summary

Modifier and Type	Method	Description
Optional<LocationVO>	findByErpCodeOpt(String erpCode)	Find and return a Location representation by the given erpCode.
Optional<LocationVO>	findByIdOpt(String locationId)	Find and return a Location representation by the given locationId.

Field Details

API_VERSION

static final String API_VERSION

API version.

See Also:

• Constant Field Values

API_LOCATIONS

static final String API_LOCATIONS

API root to hit Locations (plural).

See Also:

• Constant Field Values

Method Details

findByIdOpt

@GetMapping(value="/v1/locations",
            params="locationPK")
@Cacheable("locations")
Optional<LocationVO> findByIdOpt(@RequestParam("locationId")
 String locationId)

Find and return a Location representation by the given locationId.

Parameters:

locationId - The business key of the Location

Returns:

Never null

Throws:

IllegalArgumentException - in case the given locationId is not valid

findByErpCodeOpt

@GetMapping(value="/v1/locations",
            params="erpCode")
@Cacheable("wmsLocations")
Optional<LocationVO> findByErpCodeOpt(@RequestParam("erpCode")
 String erpCode)

Find and return a Location representation by the given erpCode.

Parameters:

erpCode - The ERP code

Returns:

Never null