Package org.openwms.common.account.api

Interface AccountApi

@FeignClient(name="common-service",
             dismiss404=true,
             qualifiers="accountApi")
public interface AccountApi

A AccountApi.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
List<AccountVO>	findAll()	Find and return all existing Accounts.
AccountVO	findByIdentifier(String identifier)	Find and return an Account.
AccountVO	findByName(String name)	Find and return an Account.
org.springframework.http.ResponseEntity<AccountVO>	findDefault()	Find and return the Account marked as default.

Method Details

findDefault

@GetMapping(value="/v1/accounts",
            params="default")
@Cacheable("accounts")
org.springframework.http.ResponseEntity<AccountVO> findDefault()

Find and return the Account marked as default.

Returns:

The instance or 404-Not Found

findAll

@GetMapping("/v1/accounts")
@Cacheable("accounts")
List<AccountVO> findAll()

Find and return all existing Accounts.

Returns:

An (empty) list of all Accounts.

findByIdentifier

@GetMapping(value="/v1/accounts",
            params="identifier")
@Cacheable("accounts")
AccountVO findByIdentifier(@RequestParam("identifier")
 String identifier)

Find and return an Account.

Parameters:

identifier - The Account's identifier

Returns:

The Account instance or 404-Not Found

findByName

@GetMapping(value="/v1/accounts",
            params="name")
@Cacheable("accounts")
AccountVO findByName(@RequestParam("name")
 String name)

Find and return an Account.

Parameters:

name - The Account's name

Returns:

The Account instance or 404-Not Found