POST ShortApplication/GetPreQualified

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
lender	Lender	None.
calculate	CalculateInput	None.
purchasePrice	string	None.
maxAffordability	string	None.
CreditPullType	string	None.
CreditScore	DDModel	None.
CreditPullFlag	boolean	None.
PropertyDetails	MoxiProperty	None.
Consent	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "lender": {
    "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"
  },
  "calculate": {
    "income": 1.1,
    "price": 2.1,
    "debt": 3.1,
    "downpayment": 4.1,
    "rate": 5.1,
    "amort": 6.1
  },
  "purchasePrice": "sample string 1",
  "maxAffordability": "sample string 2",
  "CreditPullType": "sample string 3",
  "CreditScore": {
    "label": "sample string 1",
    "value": 2
  },
  "CreditPullFlag": true,
  "PropertyDetails": {
    "ListPrice": 1.0,
    "ListingID": "sample string 2",
    "Address": "sample string 3",
    "City": "sample string 4",
    "StateOrProvince": "sample string 5",
    "CountryCode": "sample string 6",
    "PostalCode": "sample string 7",
    "ListAgentUUID": "sample string 8",
    "ListingImages": [
      "sample string 1",
      "sample string 2"
    ],
    "moxi_works_agent_id": "sample string 9",
    "name": "sample string 10",
    "CompanyName": "sample string 11",
    "EmailAddress": "sample string 12",
    "main_phone_number": "sample string 13",
    "mobile_phone_number": "sample string 14",
    "profile_image_url": "sample string 15",
    "profile_thumb_url": "sample string 16",
    "ListingBrokerage": "sample string 17",
    "Domain": "sample string 18",
    "BrokerageEmailAddress": "sample string 19"
  },
  "Consent": true
}

application/xml, text/xml

Sample:

<GetPreQualifiedInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <Consent>true</Consent>
  <CreditPullFlag>true</CreditPullFlag>
  <CreditPullType>sample string 3</CreditPullType>
  <CreditScore>
    <label>sample string 1</label>
    <value>2</value>
  </CreditScore>
  <PropertyDetails>
    <Address>sample string 3</Address>
    <BrokerageEmailAddress>sample string 19</BrokerageEmailAddress>
    <City>sample string 4</City>
    <CompanyName>sample string 11</CompanyName>
    <CountryCode>sample string 6</CountryCode>
    <Domain>sample string 18</Domain>
    <EmailAddress>sample string 12</EmailAddress>
    <ListAgentUUID>sample string 8</ListAgentUUID>
    <ListPrice>1</ListPrice>
    <ListingBrokerage>sample string 17</ListingBrokerage>
    <ListingID>sample string 2</ListingID>
    <ListingImages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ListingImages>
    <PostalCode>sample string 7</PostalCode>
    <StateOrProvince>sample string 5</StateOrProvince>
    <main_phone_number>sample string 13</main_phone_number>
    <mobile_phone_number>sample string 14</mobile_phone_number>
    <moxi_works_agent_id>sample string 9</moxi_works_agent_id>
    <name>sample string 10</name>
    <profile_image_url>sample string 15</profile_image_url>
    <profile_thumb_url>sample string 16</profile_thumb_url>
  </PropertyDetails>
  <calculate>
    <amort>6.1</amort>
    <debt>3.1</debt>
    <downpayment>4.1</downpayment>
    <income>1.1</income>
    <price>2.1</price>
    <rate>5.1</rate>
  </calculate>
  <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>
  <maxAffordability>sample string 2</maxAffordability>
  <purchasePrice>sample string 1</purchasePrice>
</GetPreQualifiedInput>

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 'GetPreQualifiedInput'.

Response Information

Resource Description

GetPreQualifiedOutput

Name	Description	Type	Additional information
Key		string	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Key": "sample string 1",
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<GetPreQualifiedOutput 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>
  <Key>sample string 1</Key>
</GetPreQualifiedOutput>