POST 17.0/database/contactpropertyrequirements/list

Description

Retrieve a list of Contact Property Requirements

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of ContactPropertyRequirementsUpdate
Name Description Type Additional information
ContactID

integer

None.
UpdatedDate

date

None.
Category

byte

None.
Usage

byte

None.
MinPrice

decimal number

None.
MaxPrice

decimal number

None.
MinPriceMatch

decimal number

None.
MaxPriceMatch

decimal number

None.
PriceFrequency

byte

None.
PriceVariance

integer

None.
Age

byte

None.
MaxBedrooms

byte

None.
Bedrooms

byte

None.
ReceptionRooms

byte

None.
Bathrooms

byte

None.
Garage

byte

None.
Garden

byte

None.
Retirement

byte

None.
DisabledAccess

byte

None.
DevelopmentPotential

byte

None.
InvestmentPotential

byte

None.
PreparedToUpdate

byte

None.
Riverside

byte

None.
Seaside

byte

None.
LeisureFacilities

byte

None.
PropertyBuyingPositionID

integer

None.
SolicitorID

integer

None.
Tenure

integer

None.
MortgageProviderID

integer

None.
MortgageAmount

decimal number

None.
MortgageReference

string

String length: inclusive between 0 and 30
EstateAgentID

integer

None.
RentalTerms

byte

None.
RentalFurnished

byte

None.
RentalSmoker

byte

None.
RentalChildren

byte

None.
RentalBenefit

byte

None.
RentalStudent

byte

None.
RentalPets

byte

None.
RequiredMovingDate

date

None.
Notes

string

String length: inclusive between 0 and 255
Parking

byte

None.
Land

byte

None.
MinFloorArea

decimal number

None.
MaxFloorArea

decimal number

None.
MinLandArea

decimal number

None.
MaxLandArea

decimal number

None.
ExLowerGroundFloor

byte

None.
ExGroundFloor

byte

None.
ExFirstFloorWithoutLift

byte

None.
ExFirstFloorWithLift

byte

None.
ExSecondFloorWithoutLift

byte

None.
ExSecondFloorWithLift

byte

None.
Qualification

byte

None.
PropertiesSent

byte

None.
CriticalCare

byte

None.

application/json, text/json
Sample: 
[
  {
    "contactID": 1,
    "updatedDate": "2025-01-09T20:37",
    "category": 64,
    "usage": 64,
    "minPrice": 1.0,
    "maxPrice": 1.0,
    "minPriceMatch": 1.0,
    "maxPriceMatch": 1.0,
    "priceFrequency": 64,
    "priceVariance": 1,
    "age": 64,
    "maxBedrooms": 64,
    "bedrooms": 64,
    "receptionRooms": 64,
    "bathrooms": 64,
    "garage": 64,
    "garden": 64,
    "retirement": 64,
    "disabledAccess": 64,
    "developmentPotential": 64,
    "investmentPotential": 64,
    "preparedToUpdate": 64,
    "riverside": 64,
    "seaside": 64,
    "leisureFacilities": 64,
    "propertyBuyingPositionID": 1,
    "solicitorID": 1,
    "tenure": 1,
    "mortgageProviderID": 1,
    "mortgageAmount": 1.0,
    "mortgageReference": "sample string 1",
    "estateAgentID": 1,
    "rentalTerms": 64,
    "rentalFurnished": 64,
    "rentalSmoker": 64,
    "rentalChildren": 64,
    "rentalBenefit": 64,
    "rentalStudent": 64,
    "rentalPets": 64,
    "requiredMovingDate": "2025-01-09T20:37",
    "notes": "sample string 2",
    "parking": 64,
    "land": 64,
    "minFloorArea": 1.0,
    "maxFloorArea": 1.0,
    "minLandArea": 1.0,
    "maxLandArea": 1.0,
    "exLowerGroundFloor": 64,
    "exGroundFloor": 64,
    "exFirstFloorWithoutLift": 64,
    "exFirstFloorWithLift": 64,
    "exSecondFloorWithoutLift": 64,
    "exSecondFloorWithLift": 64,
    "qualification": 64,
    "propertiesSent": 64,
    "criticalCare": 64
  },
  {
    "contactID": 1,
    "updatedDate": "2025-01-09T20:37",
    "category": 64,
    "usage": 64,
    "minPrice": 1.0,
    "maxPrice": 1.0,
    "minPriceMatch": 1.0,
    "maxPriceMatch": 1.0,
    "priceFrequency": 64,
    "priceVariance": 1,
    "age": 64,
    "maxBedrooms": 64,
    "bedrooms": 64,
    "receptionRooms": 64,
    "bathrooms": 64,
    "garage": 64,
    "garden": 64,
    "retirement": 64,
    "disabledAccess": 64,
    "developmentPotential": 64,
    "investmentPotential": 64,
    "preparedToUpdate": 64,
    "riverside": 64,
    "seaside": 64,
    "leisureFacilities": 64,
    "propertyBuyingPositionID": 1,
    "solicitorID": 1,
    "tenure": 1,
    "mortgageProviderID": 1,
    "mortgageAmount": 1.0,
    "mortgageReference": "sample string 1",
    "estateAgentID": 1,
    "rentalTerms": 64,
    "rentalFurnished": 64,
    "rentalSmoker": 64,
    "rentalChildren": 64,
    "rentalBenefit": 64,
    "rentalStudent": 64,
    "rentalPets": 64,
    "requiredMovingDate": "2025-01-09T20:37",
    "notes": "sample string 2",
    "parking": 64,
    "land": 64,
    "minFloorArea": 1.0,
    "maxFloorArea": 1.0,
    "minLandArea": 1.0,
    "maxLandArea": 1.0,
    "exLowerGroundFloor": 64,
    "exGroundFloor": 64,
    "exFirstFloorWithoutLift": 64,
    "exFirstFloorWithLift": 64,
    "exSecondFloorWithoutLift": 64,
    "exSecondFloorWithLift": 64,
    "qualification": 64,
    "propertiesSent": 64,
    "criticalCare": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfContactPropertyRequirementsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactPropertyRequirementsUpdate>
    <ContactID>1</ContactID>
    <UpdatedDate>2025-01-09T20:37:08.879156+00:00</UpdatedDate>
    <Category>64</Category>
    <Usage>64</Usage>
    <MinPrice>1</MinPrice>
    <MaxPrice>1</MaxPrice>
    <MinPriceMatch>1</MinPriceMatch>
    <MaxPriceMatch>1</MaxPriceMatch>
    <PriceFrequency>64</PriceFrequency>
    <PriceVariance>1</PriceVariance>
    <Age>64</Age>
    <MaxBedrooms>64</MaxBedrooms>
    <Bedrooms>64</Bedrooms>
    <ReceptionRooms>64</ReceptionRooms>
    <Bathrooms>64</Bathrooms>
    <Garage>64</Garage>
    <Garden>64</Garden>
    <Retirement>64</Retirement>
    <DisabledAccess>64</DisabledAccess>
    <DevelopmentPotential>64</DevelopmentPotential>
    <InvestmentPotential>64</InvestmentPotential>
    <PreparedToUpdate>64</PreparedToUpdate>
    <Riverside>64</Riverside>
    <Seaside>64</Seaside>
    <LeisureFacilities>64</LeisureFacilities>
    <PropertyBuyingPositionID>1</PropertyBuyingPositionID>
    <SolicitorID>1</SolicitorID>
    <Tenure>1</Tenure>
    <MortgageProviderID>1</MortgageProviderID>
    <MortgageAmount>1</MortgageAmount>
    <MortgageReference>sample string 1</MortgageReference>
    <EstateAgentID>1</EstateAgentID>
    <RentalTerms>64</RentalTerms>
    <RentalFurnished>64</RentalFurnished>
    <RentalSmoker>64</RentalSmoker>
    <RentalChildren>64</RentalChildren>
    <RentalBenefit>64</RentalBenefit>
    <RentalStudent>64</RentalStudent>
    <RentalPets>64</RentalPets>
    <RequiredMovingDate>2025-01-09T20:37:08.879156+00:00</RequiredMovingDate>
    <Notes>sample string 2</Notes>
    <Parking>64</Parking>
    <Land>64</Land>
    <MinFloorArea>1</MinFloorArea>
    <MaxFloorArea>1</MaxFloorArea>
    <MinLandArea>1</MinLandArea>
    <MaxLandArea>1</MaxLandArea>
    <ExLowerGroundFloor>64</ExLowerGroundFloor>
    <ExGroundFloor>64</ExGroundFloor>
    <ExFirstFloorWithoutLift>64</ExFirstFloorWithoutLift>
    <ExFirstFloorWithLift>64</ExFirstFloorWithLift>
    <ExSecondFloorWithoutLift>64</ExSecondFloorWithoutLift>
    <ExSecondFloorWithLift>64</ExSecondFloorWithLift>
    <Qualification>64</Qualification>
    <PropertiesSent>64</PropertiesSent>
    <CriticalCare>64</CriticalCare>
  </ContactPropertyRequirementsUpdate>
  <ContactPropertyRequirementsUpdate>
    <ContactID>1</ContactID>
    <UpdatedDate>2025-01-09T20:37:08.879156+00:00</UpdatedDate>
    <Category>64</Category>
    <Usage>64</Usage>
    <MinPrice>1</MinPrice>
    <MaxPrice>1</MaxPrice>
    <MinPriceMatch>1</MinPriceMatch>
    <MaxPriceMatch>1</MaxPriceMatch>
    <PriceFrequency>64</PriceFrequency>
    <PriceVariance>1</PriceVariance>
    <Age>64</Age>
    <MaxBedrooms>64</MaxBedrooms>
    <Bedrooms>64</Bedrooms>
    <ReceptionRooms>64</ReceptionRooms>
    <Bathrooms>64</Bathrooms>
    <Garage>64</Garage>
    <Garden>64</Garden>
    <Retirement>64</Retirement>
    <DisabledAccess>64</DisabledAccess>
    <DevelopmentPotential>64</DevelopmentPotential>
    <InvestmentPotential>64</InvestmentPotential>
    <PreparedToUpdate>64</PreparedToUpdate>
    <Riverside>64</Riverside>
    <Seaside>64</Seaside>
    <LeisureFacilities>64</LeisureFacilities>
    <PropertyBuyingPositionID>1</PropertyBuyingPositionID>
    <SolicitorID>1</SolicitorID>
    <Tenure>1</Tenure>
    <MortgageProviderID>1</MortgageProviderID>
    <MortgageAmount>1</MortgageAmount>
    <MortgageReference>sample string 1</MortgageReference>
    <EstateAgentID>1</EstateAgentID>
    <RentalTerms>64</RentalTerms>
    <RentalFurnished>64</RentalFurnished>
    <RentalSmoker>64</RentalSmoker>
    <RentalChildren>64</RentalChildren>
    <RentalBenefit>64</RentalBenefit>
    <RentalStudent>64</RentalStudent>
    <RentalPets>64</RentalPets>
    <RequiredMovingDate>2025-01-09T20:37:08.879156+00:00</RequiredMovingDate>
    <Notes>sample string 2</Notes>
    <Parking>64</Parking>
    <Land>64</Land>
    <MinFloorArea>1</MinFloorArea>
    <MaxFloorArea>1</MaxFloorArea>
    <MinLandArea>1</MinLandArea>
    <MaxLandArea>1</MaxLandArea>
    <ExLowerGroundFloor>64</ExLowerGroundFloor>
    <ExGroundFloor>64</ExGroundFloor>
    <ExFirstFloorWithoutLift>64</ExFirstFloorWithoutLift>
    <ExFirstFloorWithLift>64</ExFirstFloorWithLift>
    <ExSecondFloorWithoutLift>64</ExSecondFloorWithoutLift>
    <ExSecondFloorWithLift>64</ExSecondFloorWithLift>
    <Qualification>64</Qualification>
    <PropertiesSent>64</PropertiesSent>
    <CriticalCare>64</CriticalCare>
  </ContactPropertyRequirementsUpdate>
</ArrayOfContactPropertyRequirementsUpdate>