POST dosconnect/NewOtherProperty

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
ApplicantID	integer	None.
Property	UpdateOtherPropertyModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ApplicantID": 2,
  "Property": {
    "Address": {
      "AddressID": 1,
      "UnitNumber": "sample string 2",
      "StreetNumber": "sample string 3",
      "StreetName": "sample string 4",
      "StreetTypeDD": 1,
      "StreetDirectionDD": 1,
      "City": "sample string 5",
      "ProvinceDD": 1,
      "InternationalPostalCode": "sample string 6",
      "PostalFsa": "sample string 7",
      "PostalLdu": "sample string 8",
      "CountryTypeDD": 1
    },
    "OccupancyTypeDD": 1,
    "PropertyValue": 1.0,
    "OriginalValue": 1.0,
    "PurchaseDate": "2025-04-11T07:15:53.1415413-04:00",
    "IncludeInTDSCalculationFlag": true,
    "AnnualTaxes": 1.0,
    "CondoFees": 1.0,
    "IncludePercentCondoFees": 1.0,
    "Heating": 1.0
  }
}

application/xml, text/xml

Sample:

<NewOtherPropertyInput 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>
  <Property>
    <Address>
      <AddressID>1</AddressID>
      <City>sample string 5</City>
      <CountryTypeDD>1</CountryTypeDD>
      <InternationalPostalCode>sample string 6</InternationalPostalCode>
      <PostalFsa>sample string 7</PostalFsa>
      <PostalLdu>sample string 8</PostalLdu>
      <ProvinceDD>1</ProvinceDD>
      <StreetDirectionDD>1</StreetDirectionDD>
      <StreetName>sample string 4</StreetName>
      <StreetNumber>sample string 3</StreetNumber>
      <StreetTypeDD>1</StreetTypeDD>
      <UnitNumber>sample string 2</UnitNumber>
    </Address>
    <AnnualTaxes>1</AnnualTaxes>
    <CondoFees>1</CondoFees>
    <Heating>1</Heating>
    <IncludeInTDSCalculationFlag>true</IncludeInTDSCalculationFlag>
    <IncludePercentCondoFees>1</IncludePercentCondoFees>
    <OccupancyTypeDD>1</OccupancyTypeDD>
    <OriginalValue>1</OriginalValue>
    <PropertyValue>1</PropertyValue>
    <PurchaseDate>2025-04-11T07:15:53.1415413-04:00</PurchaseDate>
  </Property>
</NewOtherPropertyInput>

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

Response Information

Resource Description

NewOtherPropertyOutput

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

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<NewOtherPropertyOutput 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>
  <PropertyID>1</PropertyID>
</NewOtherPropertyOutput>