POST ShortApplication/Calculate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
income	decimal number	None.
price	decimal number	None.
debt	decimal number	None.
downpayment	decimal number	None.
rate	decimal number	None.
amort	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "income": 1.1,
  "price": 2.1,
  "debt": 3.1,
  "downpayment": 4.1,
  "rate": 5.1,
  "amort": 6.1
}

application/xml, text/xml

Sample:

<CalculateInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <amort>6.1</amort>
  <debt>3.1</debt>
  <downpayment>4.1</downpayment>
  <income>1.1</income>
  <price>2.1</price>
  <rate>5.1</rate>
</CalculateInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CalculateInput'.

Response Information

Resource Description

CalculateOutput

Name	Type	Additional information
MaxPurchasePrice	decimal number	None.
MaxMonthlyMortgage	decimal number	None.
Lenders	Collection of Lender	None.
Eligible	boolean	None.
Affordable	boolean	None.
Gds	decimal number	None.
Tds	decimal number	None.
ReturnStatus	ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "MaxPurchasePrice": 1.1,
  "MaxMonthlyMortgage": 2.1,
  "Lenders": [
    {
      "LenderID": 1,
      "name": "sample string 2",
      "icon": "sample string 3",
      "rate": 4.0,
      "insuredrate": 5.0,
      "insurablerate": 6.0,
      "uninsurablerate": 7.0,
      "term": 8,
      "payment": 9.1,
      "strpayment": "sample string 10",
      "Gds": 11.1,
      "Tds": 12.1,
      "backgroundcolor": "sample string 13"
    },
    {
      "LenderID": 1,
      "name": "sample string 2",
      "icon": "sample string 3",
      "rate": 4.0,
      "insuredrate": 5.0,
      "insurablerate": 6.0,
      "uninsurablerate": 7.0,
      "term": 8,
      "payment": 9.1,
      "strpayment": "sample string 10",
      "Gds": 11.1,
      "Tds": 12.1,
      "backgroundcolor": "sample string 13"
    }
  ],
  "Eligible": true,
  "Affordable": true,
  "Gds": 5.1,
  "Tds": 6.1,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<CalculateOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <Affordable>true</Affordable>
  <Eligible>true</Eligible>
  <Gds>5.1</Gds>
  <Lenders>
    <Lender>
      <Gds>11.1</Gds>
      <LenderID>1</LenderID>
      <Tds>12.1</Tds>
      <backgroundcolor>sample string 13</backgroundcolor>
      <icon>sample string 3</icon>
      <insurablerate>6</insurablerate>
      <insuredrate>5</insuredrate>
      <name>sample string 2</name>
      <payment>9.1</payment>
      <rate>4</rate>
      <strpayment>sample string 10</strpayment>
      <term>8</term>
      <uninsurablerate>7</uninsurablerate>
    </Lender>
    <Lender>
      <Gds>11.1</Gds>
      <LenderID>1</LenderID>
      <Tds>12.1</Tds>
      <backgroundcolor>sample string 13</backgroundcolor>
      <icon>sample string 3</icon>
      <insurablerate>6</insurablerate>
      <insuredrate>5</insuredrate>
      <name>sample string 2</name>
      <payment>9.1</payment>
      <rate>4</rate>
      <strpayment>sample string 10</strpayment>
      <term>8</term>
      <uninsurablerate>7</uninsurablerate>
    </Lender>
  </Lenders>
  <MaxMonthlyMortgage>2.1</MaxMonthlyMortgage>
  <MaxPurchasePrice>1.1</MaxPurchasePrice>
  <Tds>6.1</Tds>
</CalculateOutput>