POST leads/mortgage-inquires/add

Add mortgage inquiry

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LeadId	integer	None.
SearchStatus	integer	None.
PropertyUsage	integer	None.
LoanPurpose	integer	None.
LoanType	integer	None.
Timing	integer	None.
RenewalDate	string	None.
PropertyType	integer	None.
PurchasePrice	decimal number	None.
PropertyValue	decimal number	None.
DownPayment	decimal number	None.
AdditionalCash	decimal number	None.
LoanAmount	decimal number	None.
PropertyAddress	PropertyAddressModel	None.
CustomFields	Collection of APICustomFieldModel	None.

Request Formats

application/json, text/json

Sample:

{
  "LeadId": 1,
  "SearchStatus": 1,
  "PropertyUsage": 1,
  "LoanPurpose": 1,
  "LoanType": 1,
  "Timing": 1,
  "RenewalDate": "sample string 2",
  "PropertyType": 1,
  "PurchasePrice": 1.0,
  "PropertyValue": 1.0,
  "DownPayment": 1.0,
  "AdditionalCash": 1.0,
  "LoanAmount": 3.0,
  "PropertyAddress": {
    "Unit": "sample string 1",
    "StreetNumber": "sample string 2",
    "StreetName": "sample string 3",
    "StreetType": "sample string 4",
    "StreetDirection": "sample string 5",
    "City": "sample string 6",
    "Province": "sample string 7",
    "PostalCode": "sample string 8",
    "Country": "sample string 9"
  },
  "CustomFields": [
    {
      "FieldName": "sample string 1",
      "FieldValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "FieldName": "sample string 1",
      "FieldValues": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AddMortgageInquiryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.Lead">
  <AdditionalCash>1</AdditionalCash>
  <CustomFields>
    <APICustomFieldModel>
      <FieldName>sample string 1</FieldName>
      <FieldValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </FieldValues>
    </APICustomFieldModel>
    <APICustomFieldModel>
      <FieldName>sample string 1</FieldName>
      <FieldValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </FieldValues>
    </APICustomFieldModel>
  </CustomFields>
  <DownPayment>1</DownPayment>
  <LoanAmount>3</LoanAmount>
  <LoanPurpose>1</LoanPurpose>
  <LoanType>1</LoanType>
  <PropertyAddress>
    <City>sample string 6</City>
    <Country>sample string 9</Country>
    <PostalCode>sample string 8</PostalCode>
    <Province>sample string 7</Province>
    <StreetDirection>sample string 5</StreetDirection>
    <StreetName>sample string 3</StreetName>
    <StreetNumber>sample string 2</StreetNumber>
    <StreetType>sample string 4</StreetType>
    <Unit>sample string 1</Unit>
  </PropertyAddress>
  <PropertyType>1</PropertyType>
  <PropertyUsage>1</PropertyUsage>
  <PropertyValue>1</PropertyValue>
  <PurchasePrice>1</PurchasePrice>
  <RenewalDate>sample string 2</RenewalDate>
  <SearchStatus>1</SearchStatus>
  <Timing>1</Timing>
  <LeadId>1</LeadId>
</AddMortgageInquiryModel>

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

Response Information

Resource Description

AddMortgageInquiryOutput

Name	Type	Additional information
LeadId	integer	None.
MortgageInquiryId	integer	None.
ReturnStatus	ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<AddMortgageInquiryOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.Lead">
  <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>
  <LeadId>1</LeadId>
  <MortgageInquiryId>1</MortgageInquiryId>
</AddMortgageInquiryOutput>