GET api/LoanApplication/Amend/Eligibility/{loanApplicationId}/{price}/{deposit}

Get eligible products, based on a chosen by the user loan application, price and deposit.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
loanApplicationId

globally unique identifier

Required

price

decimal number

Required

deposit

decimal number

Required

Body Parameters

None.

Response Information

Resource Description

AmendEligibilityResponseModel
NameDescriptionTypeAdditional information
ErrorMessage

string

None.

Products

Collection of EligibleProductsViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorMessage": "sample string 1",
  "Products": [
    {
      "ProductName": "sample string 1",
      "RateCardProductId": "798faf9e-d218-4a6f-8b6d-4be8c5f773fd",
      "RateCardProductCode": "sample string 3",
      "MinimumAdvance": 1.0,
      "MaximumAdvance": 1.0,
      "MinimumDeposit": 1.0,
      "MaximumDeposit": 1.0,
      "Term": 1,
      "DeferredTerm": 1,
      "TotalTerm": 1,
      "CustomerAdminFee": 1.0,
      "AnnualInterestRate": 1.0,
      "MonthlyPayment": 1.0,
      "ErrorMessage": "sample string 4"
    },
    {
      "ProductName": "sample string 1",
      "RateCardProductId": "798faf9e-d218-4a6f-8b6d-4be8c5f773fd",
      "RateCardProductCode": "sample string 3",
      "MinimumAdvance": 1.0,
      "MaximumAdvance": 1.0,
      "MinimumDeposit": 1.0,
      "MaximumDeposit": 1.0,
      "Term": 1,
      "DeferredTerm": 1,
      "TotalTerm": 1,
      "CustomerAdminFee": 1.0,
      "AnnualInterestRate": 1.0,
      "MonthlyPayment": 1.0,
      "ErrorMessage": "sample string 4"
    }
  ]
}

text/html

Sample:
{"ErrorMessage":"sample string 1","Products":[{"ProductName":"sample string 1","RateCardProductId":"798faf9e-d218-4a6f-8b6d-4be8c5f773fd","RateCardProductCode":"sample string 3","MinimumAdvance":1.0,"MaximumAdvance":1.0,"MinimumDeposit":1.0,"MaximumDeposit":1.0,"Term":1,"DeferredTerm":1,"TotalTerm":1,"CustomerAdminFee":1.0,"AnnualInterestRate":1.0,"MonthlyPayment":1.0,"ErrorMessage":"sample string 4"},{"ProductName":"sample string 1","RateCardProductId":"798faf9e-d218-4a6f-8b6d-4be8c5f773fd","RateCardProductCode":"sample string 3","MinimumAdvance":1.0,"MaximumAdvance":1.0,"MinimumDeposit":1.0,"MaximumDeposit":1.0,"Term":1,"DeferredTerm":1,"TotalTerm":1,"CustomerAdminFee":1.0,"AnnualInterestRate":1.0,"MonthlyPayment":1.0,"ErrorMessage":"sample string 4"}]}

application/xml, text/xml

Sample:
<AmendEligibilityResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.LoanApplicationResponses">
  <ErrorMessage>sample string 1</ErrorMessage>
  <Products>
    <EligibleProductsViewModel>
      <AnnualInterestRate>1</AnnualInterestRate>
      <CustomerAdminFee>1</CustomerAdminFee>
      <DeferredTerm>1</DeferredTerm>
      <ErrorMessage>sample string 4</ErrorMessage>
      <MaximumAdvance>1</MaximumAdvance>
      <MaximumDeposit>1</MaximumDeposit>
      <MinimumAdvance>1</MinimumAdvance>
      <MinimumDeposit>1</MinimumDeposit>
      <MonthlyPayment>1</MonthlyPayment>
      <ProductName>sample string 1</ProductName>
      <RateCardProductCode>sample string 3</RateCardProductCode>
      <RateCardProductId>798faf9e-d218-4a6f-8b6d-4be8c5f773fd</RateCardProductId>
      <Term>1</Term>
      <TotalTerm>1</TotalTerm>
    </EligibleProductsViewModel>
    <EligibleProductsViewModel>
      <AnnualInterestRate>1</AnnualInterestRate>
      <CustomerAdminFee>1</CustomerAdminFee>
      <DeferredTerm>1</DeferredTerm>
      <ErrorMessage>sample string 4</ErrorMessage>
      <MaximumAdvance>1</MaximumAdvance>
      <MaximumDeposit>1</MaximumDeposit>
      <MinimumAdvance>1</MinimumAdvance>
      <MinimumDeposit>1</MinimumDeposit>
      <MonthlyPayment>1</MonthlyPayment>
      <ProductName>sample string 1</ProductName>
      <RateCardProductCode>sample string 3</RateCardProductCode>
      <RateCardProductId>798faf9e-d218-4a6f-8b6d-4be8c5f773fd</RateCardProductId>
      <Term>1</Term>
      <TotalTerm>1</TotalTerm>
    </EligibleProductsViewModel>
  </Products>
</AmendEligibilityResponseModel>