GET api/Brokerage/FinanceCalculator/{brokerageId}/{term}/{price}
Retrieve a list of finance products, based on provided term and price. Available for PL broker users. Does not require authentication.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
brokerageId | globally unique identifier |
Required |
|
term | integer |
Required |
|
price | decimal number |
Required |
Body Parameters
None.
Response Information
Resource Description
Possible error responses: 1. {"BrokerageId", "ErrorMessage": "Brokerage with id = {guid} does not exist in the database."}, 2. {"Term", "ErrorMessage": "The term field has to be a positive integer."}, 3. {"Price", "ErrorMessage": "The price field has to be a positive number."}
BrokerageResponseName | Description | Type | Additional information |
---|---|---|---|
SelectedProductId | globally unique identifier |
None. |
|
Products | Collection of BrokerageFinanceCalculatorProductViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "SelectedProductId": "60213c7f-ccb8-453b-a785-f16b617f5177", "Products": [ { "Id": "ea0fb56b-3d0d-44e3-a18f-e026ec1a331d", "APR": 2.1, "MonthlyCost": 3.0, "TotalRepayment": 4.0, "Term": 5, "InterestRate": 6.0 }, { "Id": "ea0fb56b-3d0d-44e3-a18f-e026ec1a331d", "APR": 2.1, "MonthlyCost": 3.0, "TotalRepayment": 4.0, "Term": 5, "InterestRate": 6.0 } ] }
text/html
Sample:
{"SelectedProductId":"60213c7f-ccb8-453b-a785-f16b617f5177","Products":[{"Id":"ea0fb56b-3d0d-44e3-a18f-e026ec1a331d","APR":2.1,"MonthlyCost":3.0,"TotalRepayment":4.0,"Term":5,"InterestRate":6.0},{"Id":"ea0fb56b-3d0d-44e3-a18f-e026ec1a331d","APR":2.1,"MonthlyCost":3.0,"TotalRepayment":4.0,"Term":5,"InterestRate":6.0}]}
application/xml, text/xml
Sample:
<BrokerageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.FinanceCalculatorResponses"> <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.ViewModel"> <d2p1:BrokerageFinanceCalculatorProductViewModel> <d2p1:APR>2.1</d2p1:APR> <d2p1:Id>ea0fb56b-3d0d-44e3-a18f-e026ec1a331d</d2p1:Id> <d2p1:InterestRate>6</d2p1:InterestRate> <d2p1:MonthlyCost>3</d2p1:MonthlyCost> <d2p1:Term>5</d2p1:Term> <d2p1:TotalRepayment>4</d2p1:TotalRepayment> </d2p1:BrokerageFinanceCalculatorProductViewModel> <d2p1:BrokerageFinanceCalculatorProductViewModel> <d2p1:APR>2.1</d2p1:APR> <d2p1:Id>ea0fb56b-3d0d-44e3-a18f-e026ec1a331d</d2p1:Id> <d2p1:InterestRate>6</d2p1:InterestRate> <d2p1:MonthlyCost>3</d2p1:MonthlyCost> <d2p1:Term>5</d2p1:Term> <d2p1:TotalRepayment>4</d2p1:TotalRepayment> </d2p1:BrokerageFinanceCalculatorProductViewModel> </Products> <SelectedProductId>60213c7f-ccb8-453b-a785-f16b617f5177</SelectedProductId> </BrokerageResponse>