POST ShortApplication/LoadApplicationbyID

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Sa_ApplicationID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Sa_ApplicationID": 1
}

application/xml, text/xml

Sample:

<LoadApplicationbyIDInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <Sa_ApplicationID>1</Sa_ApplicationID>
</LoadApplicationbyIDInput>

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

Response Information

Resource Description

LoadApplicationbyIDOutput

Name	Type	Additional information
Sa_ApplicationID	integer	None.
PropertyDetails	MoxiProperty	None.
lender	Lender	None.
Income	Collection of C21Income	None.
RentalIncome	Collection of C21Income	None.
Asset	Collection of C21Asset	None.
Liability	Collection of C21Liability	None.
MortgageLiability	Collection of C21Liability	None.
Properties	Collection of C21Property	None.
purchasedPrice	string	None.
MaxAffordability	string	None.
step	integer	None.
Applicant	Applicant	None.
CoApplicant	CoApplicant	None.
SecondApplicantFlag	boolean	None.
FinancialInformationstep	string	None.
ApplicantList	Collection of DDModel	None.
enablePI	boolean	None.
ReturnStatus	ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Sa_ApplicationID": 1,
  "PropertyDetails": {
    "ListPrice": 1.0,
    "ListingID": "sample string 2",
    "Address": "sample string 3",
    "City": "sample string 4",
    "StateOrProvince": "sample string 5",
    "CountryCode": "sample string 6",
    "PostalCode": "sample string 7",
    "ListAgentUUID": "sample string 8",
    "ListingImages": [
      "sample string 1",
      "sample string 2"
    ],
    "moxi_works_agent_id": "sample string 9",
    "name": "sample string 10",
    "CompanyName": "sample string 11",
    "EmailAddress": "sample string 12",
    "main_phone_number": "sample string 13",
    "mobile_phone_number": "sample string 14",
    "profile_image_url": "sample string 15",
    "profile_thumb_url": "sample string 16",
    "ListingBrokerage": "sample string 17",
    "Domain": "sample string 18",
    "BrokerageEmailAddress": "sample string 19"
  },
  "lender": {
    "LenderID": 1,
    "name": "sample string 2",
    "icon": "sample string 3",
    "rate": 4.0,
    "insuredrate": 5.0,
    "insurablerate": 6.0,
    "uninsurablerate": 7.0,
    "term": 8,
    "payment": 9.1,
    "strpayment": "sample string 10",
    "Gds": 11.1,
    "Tds": 12.1,
    "backgroundcolor": "sample string 13"
  },
  "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
    },
    {
      "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
    }
  ],
  "RentalIncome": [
    {
      "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
    },
    {
      "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
    }
  ],
  "Asset": [
    {
      "DisplayName": "sample string 1",
      "DisplayAmount": "sample string 2",
      "AssetID": 3,
      "AssetType": 4,
      "Value": 1.0,
      "ApplicantID": {
        "label": "sample string 1",
        "value": 2
      }
    },
    {
      "DisplayName": "sample string 1",
      "DisplayAmount": "sample string 2",
      "AssetID": 3,
      "AssetType": 4,
      "Value": 1.0,
      "ApplicantID": {
        "label": "sample string 1",
        "value": 2
      }
    }
  ],
  "Liability": [
    {
      "DisplayName": "sample string 1",
      "DisplayLimit": "sample string 2",
      "DisplayBalance": "sample string 3",
      "DisplayPayment": "sample string 4",
      "LiabilityID": 5,
      "LiabilityType": 6,
      "Limit": 1.0,
      "Balance": 1.0,
      "ApplicantID": {
        "label": "sample string 1",
        "value": 2
      },
      "Payment": 1.0
    },
    {
      "DisplayName": "sample string 1",
      "DisplayLimit": "sample string 2",
      "DisplayBalance": "sample string 3",
      "DisplayPayment": "sample string 4",
      "LiabilityID": 5,
      "LiabilityType": 6,
      "Limit": 1.0,
      "Balance": 1.0,
      "ApplicantID": {
        "label": "sample string 1",
        "value": 2
      },
      "Payment": 1.0
    }
  ],
  "MortgageLiability": [
    {
      "DisplayName": "sample string 1",
      "DisplayLimit": "sample string 2",
      "DisplayBalance": "sample string 3",
      "DisplayPayment": "sample string 4",
      "LiabilityID": 5,
      "LiabilityType": 6,
      "Limit": 1.0,
      "Balance": 1.0,
      "ApplicantID": {
        "label": "sample string 1",
        "value": 2
      },
      "Payment": 1.0
    },
    {
      "DisplayName": "sample string 1",
      "DisplayLimit": "sample string 2",
      "DisplayBalance": "sample string 3",
      "DisplayPayment": "sample string 4",
      "LiabilityID": 5,
      "LiabilityType": 6,
      "Limit": 1.0,
      "Balance": 1.0,
      "ApplicantID": {
        "label": "sample string 1",
        "value": 2
      },
      "Payment": 1.0
    }
  ],
  "Properties": [
    {
      "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
        }
      ]
    },
    {
      "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
        }
      ]
    }
  ],
  "purchasedPrice": "sample string 2",
  "MaxAffordability": "sample string 3",
  "step": 4,
  "Applicant": {
    "ApplicantID": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "DateOfBirth": "sample string 4",
    "CreditScore": {
      "label": "sample string 1",
      "value": 2
    },
    "EmailAddress": "sample string 5",
    "Phone": "sample string 6",
    "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"
    }
  },
  "CoApplicant": {
    "ApplicantID": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "EmailAddress": "sample string 4"
  },
  "SecondApplicantFlag": true,
  "FinancialInformationstep": "sample string 6",
  "ApplicantList": [
    {
      "label": "sample string 1",
      "value": 2
    },
    {
      "label": "sample string 1",
      "value": 2
    }
  ],
  "enablePI": true,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<LoadApplicationbyIDOutput 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>
  <Applicant>
    <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>1</ApplicantID>
    <CreditScore>
      <label>sample string 1</label>
      <value>2</value>
    </CreditScore>
    <DateOfBirth>sample string 4</DateOfBirth>
    <EmailAddress>sample string 5</EmailAddress>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <Phone>sample string 6</Phone>
  </Applicant>
  <ApplicantList>
    <DDModel>
      <label>sample string 1</label>
      <value>2</value>
    </DDModel>
    <DDModel>
      <label>sample string 1</label>
      <value>2</value>
    </DDModel>
  </ApplicantList>
  <Asset>
    <C21Asset>
      <ApplicantID>
        <label>sample string 1</label>
        <value>2</value>
      </ApplicantID>
      <AssetID>3</AssetID>
      <AssetType>4</AssetType>
      <DisplayAmount>sample string 2</DisplayAmount>
      <DisplayName>sample string 1</DisplayName>
      <Value>1</Value>
    </C21Asset>
    <C21Asset>
      <ApplicantID>
        <label>sample string 1</label>
        <value>2</value>
      </ApplicantID>
      <AssetID>3</AssetID>
      <AssetType>4</AssetType>
      <DisplayAmount>sample string 2</DisplayAmount>
      <DisplayName>sample string 1</DisplayName>
      <Value>1</Value>
    </C21Asset>
  </Asset>
  <CoApplicant>
    <ApplicantID>1</ApplicantID>
    <EmailAddress>sample string 4</EmailAddress>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
  </CoApplicant>
  <FinancialInformationstep>sample string 6</FinancialInformationstep>
  <Income>
    <C21Income>
      <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>
    </C21Income>
    <C21Income>
      <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>
    </C21Income>
  </Income>
  <Liability>
    <C21Liability>
      <ApplicantID>
        <label>sample string 1</label>
        <value>2</value>
      </ApplicantID>
      <Balance>1</Balance>
      <DisplayBalance>sample string 3</DisplayBalance>
      <DisplayLimit>sample string 2</DisplayLimit>
      <DisplayName>sample string 1</DisplayName>
      <DisplayPayment>sample string 4</DisplayPayment>
      <LiabilityID>5</LiabilityID>
      <LiabilityType>6</LiabilityType>
      <Limit>1</Limit>
      <Payment>1</Payment>
    </C21Liability>
    <C21Liability>
      <ApplicantID>
        <label>sample string 1</label>
        <value>2</value>
      </ApplicantID>
      <Balance>1</Balance>
      <DisplayBalance>sample string 3</DisplayBalance>
      <DisplayLimit>sample string 2</DisplayLimit>
      <DisplayName>sample string 1</DisplayName>
      <DisplayPayment>sample string 4</DisplayPayment>
      <LiabilityID>5</LiabilityID>
      <LiabilityType>6</LiabilityType>
      <Limit>1</Limit>
      <Payment>1</Payment>
    </C21Liability>
  </Liability>
  <MaxAffordability>sample string 3</MaxAffordability>
  <MortgageLiability>
    <C21Liability>
      <ApplicantID>
        <label>sample string 1</label>
        <value>2</value>
      </ApplicantID>
      <Balance>1</Balance>
      <DisplayBalance>sample string 3</DisplayBalance>
      <DisplayLimit>sample string 2</DisplayLimit>
      <DisplayName>sample string 1</DisplayName>
      <DisplayPayment>sample string 4</DisplayPayment>
      <LiabilityID>5</LiabilityID>
      <LiabilityType>6</LiabilityType>
      <Limit>1</Limit>
      <Payment>1</Payment>
    </C21Liability>
    <C21Liability>
      <ApplicantID>
        <label>sample string 1</label>
        <value>2</value>
      </ApplicantID>
      <Balance>1</Balance>
      <DisplayBalance>sample string 3</DisplayBalance>
      <DisplayLimit>sample string 2</DisplayLimit>
      <DisplayName>sample string 1</DisplayName>
      <DisplayPayment>sample string 4</DisplayPayment>
      <LiabilityID>5</LiabilityID>
      <LiabilityType>6</LiabilityType>
      <Limit>1</Limit>
      <Payment>1</Payment>
    </C21Liability>
  </MortgageLiability>
  <Properties>
    <C21Property>
      <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>
    </C21Property>
    <C21Property>
      <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>
    </C21Property>
  </Properties>
  <PropertyDetails>
    <Address>sample string 3</Address>
    <BrokerageEmailAddress>sample string 19</BrokerageEmailAddress>
    <City>sample string 4</City>
    <CompanyName>sample string 11</CompanyName>
    <CountryCode>sample string 6</CountryCode>
    <Domain>sample string 18</Domain>
    <EmailAddress>sample string 12</EmailAddress>
    <ListAgentUUID>sample string 8</ListAgentUUID>
    <ListPrice>1</ListPrice>
    <ListingBrokerage>sample string 17</ListingBrokerage>
    <ListingID>sample string 2</ListingID>
    <ListingImages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ListingImages>
    <PostalCode>sample string 7</PostalCode>
    <StateOrProvince>sample string 5</StateOrProvince>
    <main_phone_number>sample string 13</main_phone_number>
    <mobile_phone_number>sample string 14</mobile_phone_number>
    <moxi_works_agent_id>sample string 9</moxi_works_agent_id>
    <name>sample string 10</name>
    <profile_image_url>sample string 15</profile_image_url>
    <profile_thumb_url>sample string 16</profile_thumb_url>
  </PropertyDetails>
  <RentalIncome>
    <C21Income>
      <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>
    </C21Income>
    <C21Income>
      <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>
    </C21Income>
  </RentalIncome>
  <Sa_ApplicationID>1</Sa_ApplicationID>
  <SecondApplicantFlag>true</SecondApplicantFlag>
  <enablePI>true</enablePI>
  <lender>
    <Gds>11.1</Gds>
    <LenderID>1</LenderID>
    <Tds>12.1</Tds>
    <backgroundcolor>sample string 13</backgroundcolor>
    <icon>sample string 3</icon>
    <insurablerate>6</insurablerate>
    <insuredrate>5</insuredrate>
    <name>sample string 2</name>
    <payment>9.1</payment>
    <rate>4</rate>
    <strpayment>sample string 10</strpayment>
    <term>8</term>
    <uninsurablerate>7</uninsurablerate>
  </lender>
  <purchasedPrice>sample string 2</purchasedPrice>
  <step>4</step>
</LoadApplicationbyIDOutput>