Interface TradingPartnerAPI
- All Known Implementing Classes:
TradingPartnerAPIImpl
@RequestMapping("/api/v1/zeus/tp")
@Validated
public interface TradingPartnerAPI
Created in Intellij IDEA
User: Balaji Varadharajan
Date: 02, June 2022
Time: 11:41 AM
Project: Zeus
Package Name: com.brihaspathee.zeus.web.resource.interfaces
To change this template use File | Settings | File and Code Template
-
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<TradingPartnerDto>>createTradingPartner(TradingPartnerDto tradingPartnerDto) Create a new Trading Partnerorg.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<TradingPartnerList>>Get the all trading partners in the systemorg.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<TradingPartnerDto>>getTradingPartnerById(String tradingPartnerId) Get a trading partner details by trading partner idorg.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<TradingPartnerList>>getTradingPartnerByParameter(Map<String, String> searchParams) Get all the trading partners that match the search parameters
-
Method Details
-
getAllTradingPartners
@GetMapping org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<TradingPartnerList>> getAllTradingPartners()Get the all trading partners in the system- Returns:
- Trading Partner List
-
getTradingPartnerById
@GetMapping("/{tradingPartnerId}") org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<TradingPartnerDto>> getTradingPartnerById(@PathVariable("tradingPartnerId") String tradingPartnerId) Get a trading partner details by trading partner id- Parameters:
tradingPartnerId-- Returns:
-
getTradingPartnerByParameter
@GetMapping("/search") org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<TradingPartnerList>> getTradingPartnerByParameter(@RequestParam Map<String, String> searchParams) Get all the trading partners that match the search parameters- Parameters:
searchParams-- Returns:
-
createTradingPartner
@PostMapping org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<TradingPartnerDto>> createTradingPartner(@RequestBody TradingPartnerDto tradingPartnerDto) throws com.fasterxml.jackson.core.JsonProcessingException Create a new Trading Partner- Parameters:
tradingPartnerDto-- Returns:
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-