POST dosconnect/NewDownPayment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
MortgageApplicationID	integer	None.
DownPaymentSourceTypeDD	integer	None.
Amount	decimal number	None.
Description	string	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "MortgageApplicationID": 2,
  "DownPaymentSourceTypeDD": 1,
  "Amount": 1.0,
  "Description": "sample string 3"
}

application/xml, text/xml

Sample:

<NewDownPaymentInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <Amount>1</Amount>
  <Description>sample string 3</Description>
  <DownPaymentSourceTypeDD>1</DownPaymentSourceTypeDD>
  <APIKey>sample string 1</APIKey>
  <MortgageApplicationID>2</MortgageApplicationID>
</NewDownPaymentInput>

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

Response Information

Resource Description

NewDownPaymentOutput

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

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<NewDownPaymentOutput 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>
  <DownPaymentSourceID>1</DownPaymentSourceID>
</NewDownPaymentOutput>