Package org.openwms.wms.location.api
Interface LocationApi
@FeignClient(name="wms-inventory",
qualifiers="wmsLocationApi",
decode404=true)
public interface LocationApi
A LocationApi deals with
Location
s.- Author:
- Heiko Scherrer
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionfindByErpCodeOpt
(String erpCode) Find and return aLocation
representation by the givenerpCode
.findByIdOpt
(String locationId) Find and return aLocation
representation by the givenlocationId
.
-
Field Details
-
API_VERSION
API version.- See Also:
-
API_LOCATIONS
API root to hit Locations (plural).- See Also:
-
-
Method Details
-
findByIdOpt
@GetMapping(value="/v1/locations", params="locationPK") @Cacheable("locations") Optional<LocationVO> findByIdOpt(@RequestParam("locationId") String locationId) Find and return aLocation
representation by the givenlocationId
.- 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 aLocation
representation by the givenerpCode
.- Parameters:
erpCode
- The ERP code- Returns:
- Never null
-