POST ShortApplication/C21UpsertProperty

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Property		C21Property	None.
Sa_ApplicationID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Property": {
    "PropertyID": 1,
    "ApplicantID": {
      "label": "sample string 1",
      "value": 2
    },
    "Occupancy": 2,
    "PropertyValue": 1.0,
    "RentalIncome": 1.0,
    "Address": {
      "AddressID": 1,
      "CountryTypeDD": 1,
      "ProvinceDD": 1,
      "StreetNumber": "sample string 2",
      "PostalFsa": "sample string 3",
      "PostalLdu": "sample string 4",
      "City": "sample string 5",
      "StreetName": "sample string 6",
      "StreetTypeDD": 1,
      "StreetDirectionDD": 1,
      "Unit": "sample string 7",
      "Text": "sample string 8",
      "shortFormatAddress": "sample string 9"
    },
    "Mortgage": [
      {
        "MortgageID": 1,
        "FrequencyPayment": 2,
        "MaturityDate": "sample string 3",
        "Payment": 1.0,
        "Balance": 1.0
      },
      {
        "MortgageID": 1,
        "FrequencyPayment": 2,
        "MaturityDate": "sample string 3",
        "Payment": 1.0,
        "Balance": 1.0
      }
    ]
  },
  "Sa_ApplicationID": 1
}

application/xml, text/xml

Sample:

<C21UpsertPropertyInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <Property>
    <Address>
      <AddressID>1</AddressID>
      <City>sample string 5</City>
      <CountryTypeDD>1</CountryTypeDD>
      <PostalFsa>sample string 3</PostalFsa>
      <PostalLdu>sample string 4</PostalLdu>
      <ProvinceDD>1</ProvinceDD>
      <StreetDirectionDD>1</StreetDirectionDD>
      <StreetName>sample string 6</StreetName>
      <StreetNumber>sample string 2</StreetNumber>
      <StreetTypeDD>1</StreetTypeDD>
      <Text>sample string 8</Text>
      <Unit>sample string 7</Unit>
      <shortFormatAddress>sample string 9</shortFormatAddress>
    </Address>
    <ApplicantID>
      <label>sample string 1</label>
      <value>2</value>
    </ApplicantID>
    <Mortgage>
      <C21Mortgage>
        <Balance>1</Balance>
        <FrequencyPayment>2</FrequencyPayment>
        <MaturityDate>sample string 3</MaturityDate>
        <MortgageID>1</MortgageID>
        <Payment>1</Payment>
      </C21Mortgage>
      <C21Mortgage>
        <Balance>1</Balance>
        <FrequencyPayment>2</FrequencyPayment>
        <MaturityDate>sample string 3</MaturityDate>
        <MortgageID>1</MortgageID>
        <Payment>1</Payment>
      </C21Mortgage>
    </Mortgage>
    <Occupancy>2</Occupancy>
    <PropertyID>1</PropertyID>
    <PropertyValue>1</PropertyValue>
    <RentalIncome>1</RentalIncome>
  </Property>
  <Sa_ApplicationID>1</Sa_ApplicationID>
</C21UpsertPropertyInput>

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

Response Information

Resource Description

C21UpsertIncomeOutput

Name	Description	Type	Additional information
Income		C21Income	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Income": {
    "DisplayName": "sample string 1",
    "DisplayAmount": "sample string 2",
    "IncomeID": 3,
    "IncomeType": 4,
    "Type": 5,
    "EmployerName": "sample string 6",
    "Amount": 1.0,
    "Frequency": 7,
    "ApplicantID": {
      "label": "sample string 1",
      "value": 2
    },
    "PropertyID": 1,
    "Status": 8
  },
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<C21UpsertIncomeOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <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>
  <Income>
    <Amount>1</Amount>
    <ApplicantID>
      <label>sample string 1</label>
      <value>2</value>
    </ApplicantID>
    <DisplayAmount>sample string 2</DisplayAmount>
    <DisplayName>sample string 1</DisplayName>
    <EmployerName>sample string 6</EmployerName>
    <Frequency>7</Frequency>
    <IncomeID>3</IncomeID>
    <IncomeType>4</IncomeType>
    <PropertyID>1</PropertyID>
    <Status>8</Status>
    <Type>5</Type>
  </Income>
</C21UpsertIncomeOutput>