POST dosconnect/NewOtherPropertyMortgage

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
PropertyID	integer	None.
Mortgage	UpdateOtherPropertyMortgageModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "PropertyID": 2,
  "Mortgage": {
    "MortgageTypeDD": 1,
    "Balance": 1.0,
    "Payment": 1.0,
    "PaymentFrequencyDD": 1,
    "MaturityDate": "2025-04-11T07:42:31.1938506-04:00",
    "RateTypeDD": 1,
    "TermTypeDD": 1,
    "LoanTypeDD": 1,
    "InterestRate": 1.0,
    "BlendedAmortFlag": true,
    "MortgageHolder": "sample string 1",
    "MortgagePayoffTypeDD": 1,
    "OriginalMortgageAmount": 1.0,
    "MortgageNumber": "sample string 2",
    "Insured": true,
    "InsuranceAccount": "sample string 3",
    "MortgageInsurerDD": 1
  }
}

application/xml, text/xml

Sample:

<NewOtherPropertyMortgageInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <APIKey>sample string 1</APIKey>
  <Mortgage>
    <Balance>1</Balance>
    <BlendedAmortFlag>true</BlendedAmortFlag>
    <InsuranceAccount>sample string 3</InsuranceAccount>
    <Insured>true</Insured>
    <InterestRate>1</InterestRate>
    <LoanTypeDD>1</LoanTypeDD>
    <MaturityDate>2025-04-11T07:42:31.1938506-04:00</MaturityDate>
    <MortgageHolder>sample string 1</MortgageHolder>
    <MortgageInsurerDD>1</MortgageInsurerDD>
    <MortgageNumber>sample string 2</MortgageNumber>
    <MortgagePayoffTypeDD>1</MortgagePayoffTypeDD>
    <MortgageTypeDD>1</MortgageTypeDD>
    <OriginalMortgageAmount>1</OriginalMortgageAmount>
    <Payment>1</Payment>
    <PaymentFrequencyDD>1</PaymentFrequencyDD>
    <RateTypeDD>1</RateTypeDD>
    <TermTypeDD>1</TermTypeDD>
  </Mortgage>
  <PropertyID>2</PropertyID>
</NewOtherPropertyMortgageInput>

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

Response Information

Resource Description

NewOtherPropertyMortgageOutput

Name	Description	Type	Additional information
MortgageID		integer	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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