au.org.consumerdatastandards.holder.api

Interface BankingProductsApi

All Known Implementing Classes:

BankingProductsApiController

public interface BankingProductsApi

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<ResponseBankingProductById>	getProductDetail(@NotBlank String productId, @Min(value=1L) Integer xMinV, @Min(value=1L) Integer xV)
default Optional<org.springframework.web.context.request.NativeWebRequest>	getRequest()
org.springframework.http.ResponseEntity<ResponseBankingProductList>	listProducts(ParamEffective effective, java.time.OffsetDateTime updatedSince, String brand, BankingProductCategory productCategory, @Min(value=1L) Integer page, @Min(value=1L) Integer pageSize, @Min(value=1L) Integer xMinV, @Min(value=1L) Integer xV)

Method Detail

getRequest

default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()

getProductDetail

@RequestMapping(value="/banking/products/{productId}",
                method=GET)
org.springframework.http.ResponseEntity<ResponseBankingProductById> getProductDetail(@PathVariable(value="productId") @NotBlank
                                                                                                                                                                        @NotBlank String productId,
                                                                                                                                                                        @RequestHeader(value="x-min-v",required=false) @Min(value=1L)
                                                                                                                                                                        @Min(value=1L) Integer xMinV,
                                                                                                                                                                        @RequestHeader(value="x-v",required=false) @Min(value=1L)
                                                                                                                                                                        @Min(value=1L) Integer xV)

listProducts

@RequestMapping(value="/banking/products",
                method=GET)
org.springframework.http.ResponseEntity<ResponseBankingProductList> listProducts(@RequestParam(value="effective",required=false,defaultValue="CURRENT")
                                                                                                                                                        ParamEffective effective,
                                                                                                                                                        @RequestParam(value="updated-since",required=false)
                                                                                                                                                        java.time.OffsetDateTime updatedSince,
                                                                                                                                                        @RequestParam(value="brand",required=false)
                                                                                                                                                        String brand,
                                                                                                                                                        @RequestParam(value="product-category",required=false)
                                                                                                                                                        BankingProductCategory productCategory,
                                                                                                                                                        @RequestParam(value="page",required=false,defaultValue="1") @Min(value=1L)
                                                                                                                                                        @Min(value=1L) Integer page,
                                                                                                                                                        @RequestParam(value="page-size",required=false,defaultValue="25") @Min(value=1L)
                                                                                                                                                        @Min(value=1L) Integer pageSize,
                                                                                                                                                        @RequestHeader(value="x-min-v",required=false) @Min(value=1L)
                                                                                                                                                        @Min(value=1L) Integer xMinV,
                                                                                                                                                        @RequestHeader(value="x-v",required=false) @Min(value=1L)
                                                                                                                                                        @Min(value=1L) Integer xV)