POST api/users/{attorneyId}/properties/{propertyAddressId}/add

Process request to create new client, new property, and new appeal for the new property for specifc attorney by Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
attorneyId

Attorney Id

integer

Required

propertyAddressId

Property Address Id

integer

Required

Body Parameters

User and property data

PropertyClientAndCaseDataBindingModel
NameDescriptionTypeAdditional information
ClientName

string

None.

ClientPhoneNumber

string

None.

ClientEmail

string

None.

IsSenior

boolean

None.

IsLowIncome

boolean

None.

IsVeteran

boolean

None.

IsDisabled

boolean

None.

IsDisabledVeteran

boolean

None.

BirthYear

integer

None.

IsPrimaryResidence

boolean

None.

IsNoLongerExists

boolean

None.

IsDamagedByFire

boolean

None.

IsRecentPurchase

boolean

None.

PurchasePrice

decimal number

None.

PurchaseDate

string

None.

IsRecentlyAppraised

boolean

None.

AppraisedMarketValue

decimal number

None.

AppraisalDate

string

None.

SignedDocumentUrl

string

None.

AppealCaseFlag

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "clientName": "sample string 1",
  "clientPhoneNumber": "sample string 2",
  "clientEmail": "sample string 3",
  "isSenior": true,
  "isLowIncome": true,
  "isVeteran": true,
  "isDisabled": true,
  "isDisabledVeteran": true,
  "birthYear": 1,
  "isPrimaryResidence": true,
  "isNoLongerExists": true,
  "isDamagedByFire": true,
  "isRecentPurchase": true,
  "purchasePrice": 1.1,
  "purchaseDate": "sample string 13",
  "isRecentlyAppraised": true,
  "appraisedMarketValue": 1.1,
  "appraisalDate": "sample string 15",
  "signedDocumentUrl": "sample string 16",
  "appealCaseFlag": true
}

text/html

Sample:
{"clientName":"sample string 1","clientPhoneNumber":"sample string 2","clientEmail":"sample string 3","isSenior":true,"isLowIncome":true,"isVeteran":true,"isDisabled":true,"isDisabledVeteran":true,"birthYear":1,"isPrimaryResidence":true,"isNoLongerExists":true,"isDamagedByFire":true,"isRecentPurchase":true,"purchasePrice":1.1,"purchaseDate":"sample string 13","isRecentlyAppraised":true,"appraisedMarketValue":1.1,"appraisalDate":"sample string 15","signedDocumentUrl":"sample string 16","appealCaseFlag":true}

application/xml, text/xml

Sample:
<PropertyClientAndCaseDataBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.PropertyDataFullfillment">
  <AppealCaseFlag>true</AppealCaseFlag>
  <AppraisalDate>sample string 15</AppraisalDate>
  <AppraisedMarketValue>1.1</AppraisedMarketValue>
  <BirthYear>1</BirthYear>
  <ClientEmail>sample string 3</ClientEmail>
  <ClientName>sample string 1</ClientName>
  <ClientPhoneNumber>sample string 2</ClientPhoneNumber>
  <IsDamagedByFire>true</IsDamagedByFire>
  <IsDisabled>true</IsDisabled>
  <IsDisabledVeteran>true</IsDisabledVeteran>
  <IsLowIncome>true</IsLowIncome>
  <IsNoLongerExists>true</IsNoLongerExists>
  <IsPrimaryResidence>true</IsPrimaryResidence>
  <IsRecentPurchase>true</IsRecentPurchase>
  <IsRecentlyAppraised>true</IsRecentlyAppraised>
  <IsSenior>true</IsSenior>
  <IsVeteran>true</IsVeteran>
  <PurchaseDate>sample string 13</PurchaseDate>
  <PurchasePrice>1.1</PurchasePrice>
  <SignedDocumentUrl>sample string 16</SignedDocumentUrl>
</PropertyClientAndCaseDataBindingModel>

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

Response Information

Resource Description

OK

UserPropertyCaseSimpleResponseModel
NameDescriptionTypeAdditional information
Id

integer

None.

UserPropertyId

integer

None.

AgencyCaseId

integer

None.

CaseNumber

string

None.

StatusId

integer

None.

Status

string

None.

AgencyCaseFilingId

integer

None.

AgencyCaseFilingType

string

None.

AgencyCaseFilingYear

integer

None.

AgencyId

integer

None.

AgencyName

string

None.

TownshipName

string

None.

TownshipId

integer

None.

CountyId

integer

None.

CountyName

string

None.

AssessmentYear

integer

None.

PropertyImageUrl

string

None.

FormattedPin

string

None.

AddressFull

string

None.

FinalTaxSavings

decimal number

None.

AmountDue

decimal number

None.

AppealStartDate

date

None.

AppealEndDate

date

None.

IsExemptionCase

boolean

None.

IsCofE

boolean

None.

Assignee

string

None.

OwnerFirstName

string

None.

OwnerLastName

string

None.

OwnerPhone

string

None.

OwnerEmail

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "userPropertyId": 2,
  "agencyCaseId": 1,
  "caseNumber": "sample string 3",
  "statusId": 1,
  "status": "sample string 4",
  "agencyCaseFilingId": 1,
  "agencyCaseFilingType": "sample string 5",
  "agencyCaseFilingYear": 1,
  "agencyId": 6,
  "agencyName": "sample string 7",
  "townshipName": "sample string 8",
  "townshipId": 9,
  "countyId": 10,
  "countyName": "sample string 11",
  "assessmentYear": 12,
  "propertyImageUrl": "sample string 13",
  "formattedPin": "sample string 14",
  "addressFull": "sample string 15",
  "finalTaxSavings": 1.0,
  "amountDue": 1.0,
  "appealStartDate": "2025-05-20T15:17:25.6411287-05:00",
  "appealEndDate": "2025-05-20T15:17:25.6411287-05:00",
  "isExemptionCase": true,
  "isCofE": true,
  "assignee": "sample string 18",
  "ownerFirstName": "sample string 19",
  "ownerLastName": "sample string 20",
  "ownerPhone": "sample string 21",
  "ownerEmail": "sample string 22"
}

text/html

Sample:
{"id":1,"userPropertyId":2,"agencyCaseId":1,"caseNumber":"sample string 3","statusId":1,"status":"sample string 4","agencyCaseFilingId":1,"agencyCaseFilingType":"sample string 5","agencyCaseFilingYear":1,"agencyId":6,"agencyName":"sample string 7","townshipName":"sample string 8","townshipId":9,"countyId":10,"countyName":"sample string 11","assessmentYear":12,"propertyImageUrl":"sample string 13","formattedPin":"sample string 14","addressFull":"sample string 15","finalTaxSavings":1.0,"amountDue":1.0,"appealStartDate":"2025-05-20T15:17:25.6411287-05:00","appealEndDate":"2025-05-20T15:17:25.6411287-05:00","isExemptionCase":true,"isCofE":true,"assignee":"sample string 18","ownerFirstName":"sample string 19","ownerLastName":"sample string 20","ownerPhone":"sample string 21","ownerEmail":"sample string 22"}

application/xml, text/xml

Sample:
<UserPropertyCaseSimpleResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.CaseBinding">
  <AddressFull>sample string 15</AddressFull>
  <AgencyCaseFilingId>1</AgencyCaseFilingId>
  <AgencyCaseFilingType>sample string 5</AgencyCaseFilingType>
  <AgencyCaseFilingYear>1</AgencyCaseFilingYear>
  <AgencyCaseId>1</AgencyCaseId>
  <AgencyId>6</AgencyId>
  <AgencyName>sample string 7</AgencyName>
  <AmountDue>1</AmountDue>
  <AppealEndDate>2025-05-20T15:17:25.6411287-05:00</AppealEndDate>
  <AppealStartDate>2025-05-20T15:17:25.6411287-05:00</AppealStartDate>
  <AssessmentYear>12</AssessmentYear>
  <Assignee>sample string 18</Assignee>
  <CaseNumber>sample string 3</CaseNumber>
  <CountyId>10</CountyId>
  <CountyName>sample string 11</CountyName>
  <FinalTaxSavings>1</FinalTaxSavings>
  <FormattedPin>sample string 14</FormattedPin>
  <Id>1</Id>
  <IsCofE>true</IsCofE>
  <IsExemptionCase>true</IsExemptionCase>
  <OwnerEmail>sample string 22</OwnerEmail>
  <OwnerFirstName>sample string 19</OwnerFirstName>
  <OwnerLastName>sample string 20</OwnerLastName>
  <OwnerPhone>sample string 21</OwnerPhone>
  <PropertyImageUrl>sample string 13</PropertyImageUrl>
  <Status>sample string 4</Status>
  <StatusId>1</StatusId>
  <TownshipId>9</TownshipId>
  <TownshipName>sample string 8</TownshipName>
  <UserPropertyId>2</UserPropertyId>
</UserPropertyCaseSimpleResponseModel>