POST api/analysis/{propertyAddressId}/exemption-analysis/exemption-refunds

This method will find all certificates of error that homeowner can apply for this year. Certificates of Error are refunds for which homeowner can apply for. They represent past exemptions for the last 3 years that user was entitled to but did not receive. User can file a certificate of error for each of these exemptions in order to receive a refund.

Request Information

URI Parameters

Name	Description	Type	Additional information
propertyAddressId	Property address id	integer	Required

Body Parameters

User ownership/personal profile info

UserExemptionProfile

Name	Type	Additional information
IsPersonalResidence	boolean	None.
PropertyPurchaseDate	string	None.
HomeImprovementCompleted	boolean	None.
HomeImprovementCompletionYear	integer	None.
HomeImprovementCost	decimal number	None.
Birthday	string	None.
AnnualIncome	decimal number	None.
IsVeteran	boolean	None.
IsDisabled	boolean	None.
DisabilityLevel	decimal number	None.
DisabilityCertificationYear	integer	None.
ReturnFromServiceYear	integer	None.
IsSecondHome	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "isPersonalResidence": true,
  "propertyPurchaseDate": "sample string 2",
  "homeImprovementCompleted": true,
  "homeImprovementCompletionYear": 1,
  "homeImprovementCost": 1.0,
  "birthday": "sample string 4",
  "annualIncome": 1.1,
  "isVeteran": true,
  "isDisabled": true,
  "disabilityLevel": 1.0,
  "disabilityCertificationYear": 1,
  "returnFromServiceYear": 1,
  "isSecondHome": true
}

text/html

Sample:

{"isPersonalResidence":true,"propertyPurchaseDate":"sample string 2","homeImprovementCompleted":true,"homeImprovementCompletionYear":1,"homeImprovementCost":1.0,"birthday":"sample string 4","annualIncome":1.1,"isVeteran":true,"isDisabled":true,"disabilityLevel":1.0,"disabilityCertificationYear":1,"returnFromServiceYear":1,"isSecondHome":true}

application/xml, text/xml

Sample:

<UserExemptionProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.ExemptionBinding">
  <AnnualIncome>1.1</AnnualIncome>
  <Birthday>sample string 4</Birthday>
  <DisabilityCertificationYear>1</DisabilityCertificationYear>
  <DisabilityLevel>1</DisabilityLevel>
  <HomeImprovementCompleted>true</HomeImprovementCompleted>
  <HomeImprovementCompletionYear>1</HomeImprovementCompletionYear>
  <HomeImprovementCost>1</HomeImprovementCost>
  <IsDisabled>true</IsDisabled>
  <IsPersonalResidence>true</IsPersonalResidence>
  <IsSecondHome>true</IsSecondHome>
  <IsVeteran>true</IsVeteran>
  <PropertyPurchaseDate>sample string 2</PropertyPurchaseDate>
  <ReturnFromServiceYear>1</ReturnFromServiceYear>
</UserExemptionProfile>

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

Response Information

Resource Description

Collection of

Collection of PropertyExemptionFilingCandidate

Name	Type	Additional information
ExemptionId	integer	None.
TaxYear	integer	None.
Name	string	None.
DisplayName	string	None.
Price	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "exemptionId": 1,
    "taxYear": 2,
    "name": "sample string 3",
    "displayName": "sample string 4",
    "price": "sample string 5"
  },
  {
    "exemptionId": 1,
    "taxYear": 2,
    "name": "sample string 3",
    "displayName": "sample string 4",
    "price": "sample string 5"
  }
]

text/html

Sample:

[{"exemptionId":1,"taxYear":2,"name":"sample string 3","displayName":"sample string 4","price":"sample string 5"},{"exemptionId":1,"taxYear":2,"name":"sample string 3","displayName":"sample string 4","price":"sample string 5"}]

application/xml, text/xml

Sample:

<ArrayOfPropertyExemptionFilingCandidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos">
  <PropertyExemptionFilingCandidate>
    <DisplayName>sample string 4</DisplayName>
    <ExemptionId>1</ExemptionId>
    <Name>sample string 3</Name>
    <Price>sample string 5</Price>
    <TaxYear>2</TaxYear>
  </PropertyExemptionFilingCandidate>
  <PropertyExemptionFilingCandidate>
    <DisplayName>sample string 4</DisplayName>
    <ExemptionId>1</ExemptionId>
    <Name>sample string 3</Name>
    <Price>sample string 5</Price>
    <TaxYear>2</TaxYear>
  </PropertyExemptionFilingCandidate>
</ArrayOfPropertyExemptionFilingCandidate>