POST dosconnect/NewLiability

Request Information

URI Parameters

None.

Body Parameters

NewLiabilityInput
NameDescriptionTypeAdditional information
APIKey

string

None.

ApplicantID

integer

None.

Liability

UpdateLiabilityModel

None.

Request Formats

application/json, text/json

Sample:
{
  "APIKey": "sample string 1",
  "ApplicantID": 2,
  "Liability": {
    "LiabilityTypeDD": 1,
    "Limit": 1.0,
    "Balance": 1.0,
    "Description": "sample string 1",
    "OvrFlag": true,
    "Payment": 1.0,
    "MaturityDate": "2025-04-11T06:56:33.9940635-04:00",
    "LiabilityPayOffTypeDD": 1
  }
}

application/xml, text/xml

Sample:
<NewLiabilityInput 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>
  <ApplicantID>2</ApplicantID>
  <Liability>
    <Balance>1</Balance>
    <Description>sample string 1</Description>
    <LiabilityPayOffTypeDD>1</LiabilityPayOffTypeDD>
    <LiabilityTypeDD>1</LiabilityTypeDD>
    <Limit>1</Limit>
    <MaturityDate>2025-04-11T06:56:33.9940635-04:00</MaturityDate>
    <OvrFlag>true</OvrFlag>
    <Payment>1</Payment>
  </Liability>
</NewLiabilityInput>

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

Response Information

Resource Description

NewLiabilityOutput
NameDescriptionTypeAdditional information
LiabilityID

integer

None.

ReturnStatus

ReturnStatusModel

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<NewLiabilityOutput 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>
  <LiabilityID>1</LiabilityID>
</NewLiabilityOutput>